Skip to content

Commit

Permalink
Deprecate PaymentAddress, PayerErrors, and related members (#4850)
Browse files Browse the repository at this point in the history 
w3c/payment-request@486c07a
(w3c/payment-request#955) removed the
PaymentAddress and PayerErrors objects from the Payment Request
specification — as well as removing related members from the
PaymentRequest, PaymentResponse, and PaymentDetailsUpdate objects.

So this change adds Deprecated and Non-standard banners to the
PaymentAddress and PayerErrors articles, as well as to the articles for
all their member, and to the articles for the related members of the
PaymentRequest, PaymentResponse, and PaymentDetailsUpdate objects.

The change also removes all the Specifications tables for the deprecated
features (they’re no longer in the spec).

Related BCD change: mdn/browser-compat-data#10413
  • Loading branch information
@sideshowbarker
sideshowbarker authored May 12, 2021
1 parent 4bb8aaa commit fe4914d
Show file tree
Hide file tree
Showing 37 changed files with 62 additions and 628 deletions.
19 changes: 1 addition & 18 deletions files/en-us/web/api/payererrors/email/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
- Validation
- payment
---
<div>{{APIRef("Payment Request API")}}{{draft}}</div>
<div>{{APIRef("Payment Request API")}} {{Deprecated_header}} {{Non-standard_header}}</div>

<p>The <code><strong>email</strong></code> property is included in a
{{domxref("PayerErrors")}} object if the {{domxref("PaymentResponse.payerEmail")}}
Expand Down Expand Up @@ -59,23 +59,6 @@ <h2 id="Example">Example</h2>
}
</pre>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('Payment','#dom-payererrors-email','PayerErrors.email')}}</td>
<td>{{Spec2('Payment')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{Compat("api.PayerErrors.email")}}</p>
27 changes: 4 additions & 23 deletions files/en-us/web/api/payererrors/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- payment
- paymentAddress
---
<div>{{APIRef("Payment Request API")}}</div>
<div>{{APIRef("Payment Request API")}} {{Deprecated_header}} {{Non-standard_header}}</div>

<p><span class="seoSummary">The <strong><code>PayerErrors</code></strong> dictionary is used by the <a href="/en-US/docs/Web/API/Payment_Request_API">Payment Request API</a> to indicate the presence of—and to explain how to correct—validation errors in the payer details.</span> For each field in the payment information that fails validation, the <code>PayerErrors</code> object contains a string explaining the error.</p>

Expand All @@ -24,33 +24,14 @@
<h2 id="Properties">Properties</h2>

<dl>
<dt>{{domxref("PayerErrors.email", "email")}} {{optional_inline}}</dt>
<dt>{{domxref("PayerErrors.email", "email")}} {{optional_inline}}{{Deprecated_inline}}</dt>
<dd>If present, this {{domxref("DOMString")}} is a string describing the validation error from which the payer's email address—as given by {{domxref("PaymentResponse.payerEmail")}}—currently suffers. If this property is absent from the <code>PayerErrors</code> object, the email address passed validation.</dd>
<dt>{{domxref("PayerErrors.name", "name")}} {{optional_inline}}</dt>
<dt>{{domxref("PayerErrors.name", "name")}} {{optional_inline}}{{Deprecated_inline}}</dt>
<dd>If this {{domxref("DOMString")}} is present in the object, the {{domxref("PaymentResponse.payerName")}} property failed validation, and this string explains what needs to be corrected. If this property is absent, the paer name is fine</dd>
<dt>{{domxref("PayerErrors.phone", "phone")}} {{optional_inline}}</dt>
<dt>{{domxref("PayerErrors.phone", "phone")}} {{optional_inline}}{{Deprecated_inline}}</dt>
<dd>If present, this string is an error message explaining why the payer's phone number ({{domxref("PaymentResponse.payerPhone")}}) failed validation. This property is absent if the phone number passed validation.</dd>
</dl>

<h2 id="Example">Example</h2>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('Payment','#dom-payererrors','PayerErrors')}}</td>
<td>{{Spec2('Payment')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{Compat("api.PayerErrors")}}</p>
19 changes: 1 addition & 18 deletions files/en-us/web/api/payererrors/name/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
- name
- payment
---
<div>{{APIRef("Payment Request API")}}{{draft}}</div>
<div>{{APIRef("Payment Request API")}} {{Deprecated_header}} {{Non-standard_header}}</div>

<p>The <strong><code>name</code></strong> property is included in a
{{domxref("PayerErrors")}} object if the {{domxref("PaymentResponse.payerName",
Expand Down Expand Up @@ -64,23 +64,6 @@ <h2 id="Example">Example</h2>
}
</pre>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('Payment','#dom-payererrors-name','PayerErrors.name')}}</td>
<td>{{Spec2('Payment')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{Compat("api.PayerErrors.name")}}</p>
19 changes: 1 addition & 18 deletions files/en-us/web/api/payererrors/phone/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
- Validation
- payment
---
<div>{{APIRef("Payment Request API")}}{{draft}}</div>
<div>{{APIRef("Payment Request API")}}{{Deprecated_header}}{{Non-standard_header}}</div>

<p>The <strong><code>phone</code></strong> property is found in a
{{domxref("PayerErrors")}} object if the {{domxref("PaymentResponse.payerPhone",
Expand Down Expand Up @@ -67,23 +67,6 @@ <h2 id="Example">Example</h2>
}
</pre>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('Payment','#dom-payererrors-phone','PayerErrors.phone')}}</td>
<td>{{Spec2('Payment')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{Compat("api.PayerErrors.phone")}}</p>
21 changes: 1 addition & 20 deletions files/en-us/web/api/paymentaddress/addressline/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
- payment
- paymentAddress
---
<p>{{APIRef("Payment Request API")}}</p>
<p>{{APIRef("Payment Request API")}}{{Deprecated_header}}{{Non-standard_header}}</p>

<p><span class="seoSummary">The <strong><code>addressLine</code></strong> read-only
property of the {{domxref('PaymentAddress')}} interface is an array of
Expand Down Expand Up @@ -68,25 +68,6 @@ <h3 id="Value">Value</h3>
London SE1 0HS<br>
United Kingdom</p>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>
{{SpecName('Payment','#dom-paymentaddress-addressline','PaymentAddress.addressLine')}}
</td>
<td>{{Spec2('Payment')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{Compat("api.PaymentAddress.addressLine")}}</p>
19 changes: 1 addition & 18 deletions files/en-us/web/api/paymentaddress/city/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
- town
- village
---
<div>{{APIRef("Payment Request API")}}</div>
<div>{{APIRef("Payment Request API")}}{{Deprecated_header}}{{Non-standard_header}}}</div>

<p><span class="seoSummary">The <strong><code>city</code></strong> read-only property of
the {{domxref('PaymentAddress')}} interface returns a string containing the city or
Expand All @@ -32,23 +32,6 @@ <h3 id="Value">Value</h3>
<p>A {{domxref("DOMString")}} indicating the city or town portion of the address described
by the {{domxref("PaymentAddress")}} object.</p>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('Payment','#dom-paymentaddress-city','PaymentAddress.city')}}</td>
<td>{{Spec2('Payment')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{Compat("api.PaymentAddress.city")}}</p>
19 changes: 1 addition & 18 deletions files/en-us/web/api/paymentaddress/country/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
- payment
- paymentAddress
---
<p>{{APIRef("Payment Request API")}}</p>
<p>{{APIRef("Payment Request API")}}{{Deprecated_header}}{{Non-standard_header}}</p>

<p>The <strong><code>country</code></strong> read-only property of the
{{domxref('PaymentAddress')}} interface is a string identifying the address's country
Expand Down Expand Up @@ -45,23 +45,6 @@ <h2 id="Usage_notes">Usage notes</h2>
{{domxref("AddressErrors.country", "country")}} property is a string indicating the
validation error that occurred and, if possible, suggests how to fix it.</p>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('Payment','#dom-paymentaddress','PaymentAddress.country')}}</td>
<td>{{Spec2('Payment')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<div>
Expand Down
21 changes: 1 addition & 20 deletions files/en-us/web/api/paymentaddress/dependentlocality/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- Reference
- paymentAddress
---
<div>{{APIRef("Payment Request API")}}</div>
<div>{{APIRef("Payment Request API")}}{{Deprecated_header}}{{Non-standard_header}}</div>

<p><span class="seoSummary">The read-only <strong><code>dependentLocality</code></strong>
property of the {{domxref('PaymentAddress')}} interface is a string containing a
Expand All @@ -35,25 +35,6 @@ <h3 id="Value">Value</h3>
locality</strong>). This is a disambiguating feature of addresses in places where a
city may have areas that duplicate street names.</p>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>
{{SpecName('Payment','#dom-paymentaddress-dependentlocality','PaymentAddress.dependentLocality')}}
</td>
<td>{{Spec2('Payment')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{Compat("api.PaymentAddress.dependentLocality")}}</p>
43 changes: 13 additions & 30 deletions files/en-us/web/api/paymentaddress/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- Reference
- paymentAddress
---
<div>{{APIRef("Payment Request API")}}{{SecureContext_Header}}</div>
<div>{{APIRef("Payment Request API")}}{{SecureContext_Header}} {{Deprecated_header}}{{Non-standard_header}}</div>

<p><span class="seoSummary">The <strong><code>PaymentAddress</code></strong> interface of the <a href="/en-US/docs/Web/API/Payment_Request_API">Payment Request API</a> is used to store shipping or payment address information.</span></p>

Expand All @@ -19,27 +19,27 @@
<h2 id="Properties">Properties</h2>

<dl>
<dt>{{domxref('PaymentAddress.addressLine')}} {{readonlyinline}}</dt>
<dt>{{domxref('PaymentAddress.addressLine')}} {{readonlyinline}}{{deprecated_inline}}</dt>
<dd>An array of {{domxref("DOMString")}} objects providing each line of the address not included among the other properties. The exact size and content varies by country or location and can include, for example, a street name, house number, apartment number, rural delivery route, descriptive instructions, or post office box number.</dd>
<dt>{{domxref('PaymentAddress.country')}} {{readonlyinline}} </dt>
<dt>{{domxref('PaymentAddress.country')}} {{readonlyinline}}{{deprecated_inline}} </dt>
<dd>A {{domxref("DOMString")}} specifying the country in which the address is located, using the {{interwiki("wikipedia", "ISO-3166-1 alpha-2")}} standard. The string is always given in its canonical upper-case form. Some examples of valid <code>country</code> values: <code>"US"</code>, <code>"GB"</code>, <code>"CN"</code>, or <code>"JP"</code>.</dd>
<dt>{{domxref('PaymentAddress.city')}} {{readonlyinline}}</dt>
<dt>{{domxref('PaymentAddress.city')}} {{readonlyinline}}{{deprecated_inline}}</dt>
<dd>A {{domxref("DOMString")}} which contains the city or town portion of the address.</dd>
<dt>{{domxref('PaymentAddress.dependentLocality')}} {{readonlyinline}}</dt>
<dt>{{domxref('PaymentAddress.dependentLocality')}} {{readonlyinline}}{{deprecated_inline}}</dt>
<dd>A {{domxref("DOMString")}} giving the dependent locality or sublocality within a city, for example, a neighborhood, borough, district, or UK dependent locality.</dd>
<dt>{{domxref('PaymentAddress.organization')}} {{readonlyinline}}</dt>
<dt>{{domxref('PaymentAddress.organization')}} {{readonlyinline}}{{deprecated_inline}}</dt>
<dd>A {{domxref("DOMString")}} specifying the name of the organization, firm, company, or institution at the payment address.</dd>
<dt>{{domxref('PaymentAddress.phone')}} {{readonlyinline}}</dt>
<dt>{{domxref('PaymentAddress.phone')}} {{readonlyinline}}{{deprecated_inline}}</dt>
<dd>A {{domxref("DOMString")}} specifying the telephone number of the recipient or contact person.</dd>
<dt>{{domxref('PaymentAddress.postalCode')}} {{readonlyinline}}</dt>
<dt>{{domxref('PaymentAddress.postalCode')}} {{readonlyinline}}{{deprecated_inline}}</dt>
<dd>A {{domxref("DOMString")}} specifying a code used by a jurisdiction for mail routing, for example, the ZIP code in the United States or the PIN code in India.</dd>
<dt>{{domxref('PaymentAddress.recipient')}} {{readonlyinline}}</dt>
<dt>{{domxref('PaymentAddress.recipient')}} {{readonlyinline}}{{deprecated_inline}}</dt>
<dd>A {{domxref("DOMString")}} giving the name of the recipient, purchaser, or contact person at the payment address.</dd>
<dt>{{domxref('PaymentAddress.region')}} {{readonlyinline}}</dt>
<dt>{{domxref('PaymentAddress.region')}} {{readonlyinline}}{{deprecated_inline}}</dt>
<dd>A {{domxref("DOMString")}} containing the top level administrative subdivision of the country, for example a state, province, oblast, or prefecture.</dd>
<dt>{{domxref('PaymentAddress.regionCode')}} {{readonlyinline}}</dt>
<dt>{{domxref('PaymentAddress.regionCode')}} {{readonlyinline}}{{deprecated_inline}}</dt>
<dd>A {{domxref("DOMString")}} specifying the region of the address, represented as a "code element" of an <a href="https://en.wikipedia.org/wiki/ISO_3166-2">ISO3166-2</a> country subdivision name (e.g. "QLD" for Queensland, Australia, "CA" for California, and so on).</dd>
<dt>{{domxref('PaymentAddress.sortingCode')}} {{readonlyinline}}</dt>
<dt>{{domxref('PaymentAddress.sortingCode')}} {{readonlyinline}}{{deprecated_inline}}</dt>
<dd>A {{domxref("DOMString")}} providing a postal sorting code such as is used in France.</dd>
</dl>

Expand All @@ -59,7 +59,7 @@ <h3 id="Obsolete_properties">Obsolete properties</h3>
<h2 id="Methods">Methods</h2>

<dl>
<dt>{{domxref('PaymentAddress.toJSON()')}}</dt>
<dt>{{domxref('PaymentAddress.toJSON()')}}{{deprecated_inline}}</dt>
<dd>A standard serializer that returns a JSON representation of the <code>PaymentAddress</code> object's properties.</dd>
</dl>

Expand Down Expand Up @@ -124,23 +124,6 @@ <h2 id="Examples">Examples</h2>
}
}</pre>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('Payment','#paymentaddress-interface','PaymentAddress')}}</td>
<td>{{Spec2('Payment')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{Compat("api.PaymentAddress")}}</p>
2 changes: 1 addition & 1 deletion files/en-us/web/api/paymentaddress/languagecode/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
- WebRTC API
- rtc
---
<p>{{deprecated_header}}{{APIRef("Payment Request API")}}</p>
<p>{{deprecated_header}}{{APIRef("Payment Request API")}}{{Non-standard_header}}</p>

<p><span class="seoSummary">The <strong><code>languageCode</code></strong> read-only
property of the {{domxref('PaymentAddress')}} interface returns a string containing
Expand Down
Loading

0 comments on commit fe4914d

Please sign in to comment.