re-update documentation

Author: mattpolzin

JSONAPI.playground/Pages/Full Client & Server Example.xcplaygroundpage/Contents.swift

@@ -86,7 +86,7 @@ typealias SingleArticleDocument = Document<SingleResourceBody<Article>, NoInclud
 func articleDocument(includeAuthor: Bool) -> Either<SingleArticleDocument, SingleArticleDocumentWithIncludes> {
     // Let's pretend all of this is coming from a database:
 
-    let authorId = Author.Identifier(rawValue: "1234")
+    let authorId = Author.Id(rawValue: "1234")
 
     let article = Article(id: .init(rawValue: "5678"),
                           attributes: .init(title: .init(value: "JSON:API in Swift"),

JSONAPI.playground/Pages/Full Document Verbose Generation.xcplaygroundpage/Contents.swift

@@ -129,9 +129,9 @@ enum ArticleDocumentError: String, JSONAPIError, Codable {
 typealias SingleArticleDocument = JSONAPI.Document<SingleResourceBody<Article>, DocumentMetadata, SingleArticleDocumentLinks, Include1<Author>, APIDescription<APIDescriptionMetadata>, ArticleDocumentError>
 
 // MARK: - Instantiations
-let authorId1 = Author.Identifier()
-let authorId2 = Author.Identifier()
-let authorId3 = Author.Identifier()
+let authorId1 = Author.Id()
+let authorId2 = Author.Id()
+let authorId3 = Author.Id()
 
 let now = Date()
 let tomorrow = Calendar.current.date(byAdding: .day, value: 1, to: now)!
@@ -155,7 +155,7 @@ let author1Links = EntityLinks(selfLink: .init(url: URL(string: "https://article
 											   meta: .init(expiry: tomorrow)))
 let author1 = Author(id: authorId1,
 					 attributes: .init(name: .init(value: "James Kinney")),
-					 relationships: .init(articles: .init(ids: [article.id, Article.Identifier(), Article.Identifier()],
+					 relationships: .init(articles: .init(ids: [article.id, Article.Id(), Article.Id()],
 														  meta: .init(pagination: .init(total: 3,
 																						limit: 50,
 																						offset: 0)),
@@ -167,7 +167,7 @@ let author2Links = EntityLinks(selfLink: .init(url: URL(string: "https://article
 											   meta: .init(expiry: tomorrow)))
 let author2 = Author(id: authorId2,
 					 attributes: .init(name: .init(value: "James Kinney")),
-					 relationships: .init(articles: .init(ids: [article.id, Article.Identifier()],
+					 relationships: .init(articles: .init(ids: [article.id, Article.Id()],
 														  meta: .init(pagination: .init(total: 2,
 																						limit: 50,
 																						offset: 0)),

JSONAPI.playground/Pages/Usage.xcplaygroundpage/Contents.swift

@@ -20,18 +20,18 @@ let singleDogData = try! JSONEncoder().encode(singleDogDocument)
 // MARK: - Parse a request or response body with one Dog in it
 let dogResponse = try! JSONDecoder().decode(SingleDogDocument.self, from: singleDogData)
 let dogFromData = dogResponse.body.primaryResource?.value
-let dogOwner: Person.Identifier? = dogFromData.flatMap { $0 ~> \.owner }
+let dogOwner: Person.Id? = dogFromData.flatMap { $0 ~> \.owner }
 
 
 // MARK: - Parse a request or response body with one Dog in it using an alternative model
 typealias AltSingleDogDocument = JSONAPI.Document<SingleResourceBody<AlternativeDog>, NoMetadata, NoLinks, NoIncludes, NoAPIDescription, BasicJSONAPIError<String>>
 let altDogResponse = try! JSONDecoder().decode(AltSingleDogDocument.self, from: singleDogData)
 let altDogFromData = altDogResponse.body.primaryResource?.value
-let altDogHuman: Person.Identifier? = altDogFromData.flatMap { $0 ~> \.human }
+let altDogHuman: Person.Id? = altDogFromData.flatMap { $0 ~> \.human }
 
 
 // MARK: - Create a request or response with multiple people and dogs and houses included
-let personIds = [Person.Identifier(), Person.Identifier()]
+let personIds = [Person.Id(), Person.Id()]
 let dogs = try! [Dog(name: "Buddy", owner: personIds[0]), Dog(name: "Joy", owner: personIds[0]), Dog(name: "Travis", owner: personIds[1])]
 let houses = [House(attributes: .none, relationships: .none, meta: .none, links: .none), House(attributes: .none, relationships: .none, meta: .none, links: .none)]
 let people = try! [Person(id: personIds[0], name: ["Gary", "Doe"], favoriteColor: "Orange-Red", friends: [], dogs: [dogs[0], dogs[1]], home: houses[0]), Person(id: personIds[1], name: ["Elise", "Joy"], favoriteColor: "Red", friends: [], dogs: [dogs[2]], home: houses[1])]

README.md

@@ -151,7 +151,7 @@ extension String: CreatableRawIdType {
 
 // Create a typealias because we do not expect JSON:API Resource
 // Objects for this particular API to have Metadata or Links associated
-// with them. We also expect them to have String Identifiers.
+// with them. We also expect them to have String Ids.
 typealias JSONEntity<Description: ResourceObjectDescription> = JSONAPI.ResourceObject<Description, NoMetadata, NoLinks, String>
 
 // Similarly, create a typealias for unidentified entities. JSON:API
@@ -220,7 +220,7 @@ typealias SingleArticleDocument = Document<SingleResourceBody<Article>, NoInclud
 func articleDocument(includeAuthor: Bool) -> Either<SingleArticleDocument, SingleArticleDocumentWithIncludes> {
     // Let's pretend all of this is coming from a database:
 
-    let authorId = Author.Identifier(rawValue: "1234")
+    let authorId = Author.Id(rawValue: "1234")
 
     let article = Article(id: .init(rawValue: "5678"),
                           attributes: .init(title: .init(value: "JSON:API in Swift"),

documentation/usage.md

@@ -167,7 +167,7 @@ typealias Relationships = NoRelationships
 
 `Relationship` values boil down to `Ids` of other resource objects. To access the `Id` of a related `ResourceObject`, you can use the custom `~>` operator with the `KeyPath` of the `Relationship` from which you want the `Id`. The friends of the above `Person` `ResourceObject` can be accessed as follows (type annotations for clarity):
 ```swift
-let friendIds: [Person.Identifier] = person ~> \.friends
+let friendIds: [Person.Id] = person ~> \.friends
 ```
 
 ### `JSONAPI.Attributes`
@@ -244,8 +244,8 @@ If your computed property is wrapped in a `AttributeType` then you can still use
 
 ### Copying/Mutating `ResourceObjects`
 `ResourceObject` is a value type, so copying is its default behavior. There are three common mutations you might want to make when copying a `ResourceObject`:
-1. Assigning a new `Identifier` to the copy of an identified `ResourceObject`.
-2. Assigning a new `Identifier` to the copy of an unidentified `ResourceObject`.
+1. Assigning a new `Id` to the copy of an identified `ResourceObject`.
+2. Assigning a new `Id` to the copy of an unidentified `ResourceObject`.
 3. Change attribute or relationship values.
 
 The first two can be accomplished with code like the following:
@@ -595,9 +595,9 @@ enum UserDescription: ResourceObjectDescription {
 	}
 
 	struct Relationships: JSONAPI.Relationships {
-		public var friend: (User) -> User.Identifier {
+		public var friend: (User) -> User.Id {
 			return { user in
-				return User.Identifier(rawValue: user.friend_id)
+				return User.Id(rawValue: user.friend_id)
 			}
 		}
 	}
@@ -612,4 +612,4 @@ Given a value `user` of the above resource object type, you can access the `frie
 let friendId = user ~> \.friend
 ```
 
-This works because `friend` is defined in the form: `var {name}: ({ResourceObject}) -> {Identifier}` where `{ResourceObject}` is the `JSONAPI.ResourceObject` described by the `ResourceObjectDescription` containing the meta-relationship.
+This works because `friend` is defined in the form: `var {name}: ({ResourceObject}) -> {Id}` where `{ResourceObject}` is the `JSONAPI.ResourceObject` described by the `ResourceObjectDescription` containing the meta-relationship.