Merge pull request json-api#1412 from json-api/remove-aliases

dgeb · web-flow · commit 3a08b94a940d · 2019-08-12T16:18:49.000-04:00
Remove profile aliasing from 1.1-rc2
diff --git a/_format/1.1/index.md b/_format/1.1/index.md
@@ -561,22 +561,15 @@ related resource collection:
 #### <a href="#profile-links" id="profile-links" class="headerlink"></a> Profile Links
 
 Like all [links][link], a link in an array of `profile` links can be represented
-with a [link object]. In that case, the link object **MAY** contain an `aliases` 
-member listing any [profile aliases].
+with a [link object].
 
-Here, the `profile` key specifies an array of `profile` links, including one
-that includes a [profile alias][profile aliases]:
+Here, the `profile` key specifies an array of `profile` links:
 
 ```json
 "links": {
   "profile": [
     "http://example.com/profiles/flexible-pagination",
-    {
-      "href": "http://example.com/profiles/resource-versioning",
-      "aliases": {
-        "version": "v"
-      }
-    }
+    "http://example.com/profiles/resource-versioning"
   ]
 }
 ```
@@ -2027,19 +2020,18 @@ https://example.com/?page[cursor]=xyz&profile=https://example.com/pagination-pro
 ```
 
 
-### <a href="#profile-keywords-and-aliases" id="profile-keywords-and-aliases" class="headerlink"></a> Profile Keywords and Aliases
+### <a href="#profile-keywords" id="profile-keywords" class="headerlink"></a> Profile Keywords
 
 A profile **SHOULD** explicitly declare "keywords" for any elements that it
 introduces to the document structure. If a profile does not explicitly declare a
 keyword for an element, then the name of the element itself (i.e., its key in
 the document) is considered to be its keyword. All profile keywords **MUST** 
 meet this specification's requirements for [member names].
 
-For the purposes of aliasing, a profile's elements are defined shallowly. 
 In other words, if a profile introduces an object-valued document member, that 
-member is an element (and so subject to aliasing), but any keys in it are not 
-themselves elements. Likewise, if the profile defines an array-valued element, 
-the keys in nested objects within that array are not elements.
+member is an element, but any keys in it are not themselves elements. Likewise,
+if the profile defines an array-valued element, the keys in nested objects
+within that array are not elements.
 
 The following example profile defines a single keyword, `version`:
 
@@ -2087,42 +2079,6 @@ This profile might be applied as follows:
 }
 ```
 
-Documents that apply a particular profile **MAY** represent each keyword with an
-alternatively named member, or "alias". An alias fully assumes any meaning
-specified for a keyword, which no longer retains that meaning. Any aliases
-associated with a profile **MUST** be represented in the profile's corresponding
-`aliases` object within its [link object][links]. The key of each alias **MUST**
-be a keyword from the profile, and the value **MUST** be an alias that applies
-to this particular representation. This aliasing mechanism allows profiles to be
-applied in a way that is both consistent with the rest of the representation and
-does not conflict with other profiles.
-
-For instance, the following document provides an alias for `version`: `v`.
-Interpreters of this representation should treat the key `v` as if it were the
-key `version` described in the profile:
-
-```json
-{
-  "data": {
-    "type": "contacts",
-    "id": "345",
-    "meta": {
-      "v": "2018-04-14-879976658"
-    },
-    "attributes": {
-      "name": "Ethan"
-    }
-  },
-  "links": {
-    "profile": [{
-      "href": "http://example.com/profiles/resource-versioning",
-      "aliases": {
-        "version": "v"
-      }
-    }]
-  }
-}
-```
 
 ### <a href="#profiles-processing" id="profiles-processing" class="headerlink"></a> Processing Profiled Documents/Requests
 
@@ -2286,8 +2242,7 @@ that "The elements... specified by a profile... **MUST NOT** change over time."
 
 > The practical issue with adding a sibling element is that another profile 
 > in use on the document might already define a sibling element of the same 
-> name, and existing documents would not have any aliases defined to resolve 
-> this conflict.
+> name.
 
 However, the timestamps profile could evolve to allow other optional members, 
 such as `deleted`, in the `timestamps` object. This is possible because the 
@@ -2434,7 +2389,7 @@ request as equivalent to one in which the square brackets were percent-encoded.
 [link object]: #document-links-link-object
 [profiles]: #profiles
 [timestamps profile]: #profiles-timestamp-profile
-[profile aliases]: #profile-keywords-and-aliases
+[profile keywords]: #profile-keywords
 [error details]: #errors
 [error object]: #error-objects
 [error objects]: #errror-objects
