Update documentation with Yard links

Author: bf4

docs/jsonapi/errors.md

@@ -1,6 +1,6 @@
 [Back to Guides](../README.md)
 
-# JSON API Errors
+# [JSON API Errors](http://jsonapi.org/format/#errors)
 
 Rendering error documents requires specifying the error serializer(s):
 

lib/active_model/serializer/adapter/json_api.rb

@@ -16,6 +16,7 @@ class JsonApi < Base
         # TODO: if we like this abstraction and other API objects to it,
         # then extract to its own file and require it.
         module ApiObjects
+          # {http://jsonapi.org/format/#document-jsonapi-object Jsonapi Object}
           module Jsonapi
             ActiveModelSerializers.config.jsonapi_version = '1.0'
             ActiveModelSerializers.config.jsonapi_toplevel_meta = {}
@@ -54,6 +55,8 @@ def initialize(serializer, options = {})
           @fieldset = options[:fieldset] || ActiveModel::Serializer::Fieldset.new(options.delete(:fields))
         end
 
+        # {http://jsonapi.org/format/#crud Requests are transactional, i.e. success or failure}
+        # {http://jsonapi.org/format/#document-top-level data and errors MUST NOT coexist in the same document.}
         def serializable_hash(options = nil)
           options ||= {}
           if serializer.success?
@@ -63,6 +66,7 @@ def serializable_hash(options = nil)
           end
         end
 
+        # {http://jsonapi.org/format/#document-top-level Primary data}
         def success_document(options)
           is_collection = serializer.respond_to?(:each)
           serializers = is_collection ? serializer : [serializer]
@@ -87,6 +91,7 @@ def success_document(options)
           hash
         end
 
+        # {http://jsonapi.org/format/#errors JSON API Errors}
         # TODO: look into caching
         # rubocop:disable Style/AsciiComments
         # definition:
@@ -120,6 +125,7 @@ def fragment_cache(cached_hash, non_cached_hash)
 
         private
 
+        # {http://jsonapi.org/format/#document-resource-objects Primary data}
         def resource_objects_for(serializers)
           @primary = []
           @included = []
@@ -161,10 +167,12 @@ def process_relationship(serializer, include_tree)
           process_relationships(serializer, include_tree)
         end
 
+        # {http://jsonapi.org/format/#document-resource-object-attributes Document Resource Object Attributes}
         def attributes_for(serializer, fields)
           serializer.attributes(fields).except(:id)
         end
 
+        # {http://jsonapi.org/format/#document-resource-objects Document Resource Objects}
         def resource_object_for(serializer)
           resource_object = cache_check(serializer) do
             resource_object = ApiObjects::ResourceIdentifier.new(serializer).as_json
@@ -188,6 +196,7 @@ def resource_object_for(serializer)
           resource_object
         end
 
+        # {http://jsonapi.org/format/#document-resource-object-relationships Document Resource Object Relationship}
         def relationships_for(serializer, requested_associations)
           include_tree = IncludeTree.from_include_args(requested_associations)
           serializer.associations(include_tree).each_with_object({}) do |association, hash|
@@ -201,16 +210,19 @@ def relationships_for(serializer, requested_associations)
           end
         end
 
+        # {http://jsonapi.org/format/#document-links Document Links}
         def links_for(serializer)
           serializer._links.each_with_object({}) do |(name, value), hash|
             hash[name] = Link.new(serializer, value).as_json
           end
         end
 
+        # {http://jsonapi.org/format/#fetching-pagination Pagination Links}
         def pagination_links_for(serializer, options)
           JsonApi::PaginationLinks.new(serializer.object, options[:serialization_context]).serializable_hash(options)
         end
 
+        # {http://jsonapi.org/format/#document-meta Docment Meta}
         def meta_for(serializer)
           Meta.new(serializer).as_json
         end

lib/active_model/serializer/adapter/json_api/api_objects/relationship.rb

@@ -4,6 +4,10 @@ module Adapter
       class JsonApi
         module ApiObjects
           class Relationship
+            # {http://jsonapi.org/format/#document-resource-object-related-resource-links Document Resource Object Related Resource Links}
+            # {http://jsonapi.org/format/#document-links Document Links}
+            # {http://jsonapi.org/format/#document-resource-object-linkage Document Resource Relationship Linkage}
+            # {http://jsonapi.org/format/#document-meta Docment Meta}
             def initialize(parent_serializer, serializer, options = {}, links = {}, meta = nil)
               @object = parent_serializer.object
               @scope = parent_serializer.scope

lib/active_model/serializer/adapter/json_api/api_objects/resource_identifier.rb

@@ -4,6 +4,7 @@ module Adapter
       class JsonApi
         module ApiObjects
           class ResourceIdentifier
+            # {http://jsonapi.org/format/#document-resource-identifier-objects Resource Identifier Objects}
             def initialize(serializer)
               @id = id_for(serializer)
               @type = type_for(serializer)