Skip to content

Commit a3655d5

Browse files
committed
Corrected API documentation formatting
1 parent 79b7c79 commit a3655d5

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

docs/api.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,33 @@ highly custom rendering control.
1818

1919
Builds the `attributes` object of the JSON API resource object.
2020

21-
#### extract_relationships(fields, resource, resource_instance)
21+
#### extract_relationships
22+
23+
`extract_relationships(fields, resource, resource_instance)`
2224

2325
Builds the `relationships` top level object based on related serializers.
2426

25-
#### extract_included(fields, resource, resource_instance, included_resources)
27+
#### extract_included
28+
29+
`extract_included(fields, resource, resource_instance, included_resources)`
2630

2731
Adds related data to the top level `included` key when the request includes `?include=example,example_field2`
2832

29-
#### extract_meta(serializer, resource)
33+
#### extract_meta
34+
35+
`extract_meta(serializer, resource)`
3036

3137
Gathers the data from serializer fields specified in `meta_fields` and adds it to the `meta` object.
3238

33-
#### extract_root_meta(serializer, resource, meta)
39+
#### extract_root_meta
40+
41+
`extract_root_meta(serializer, resource, meta)`
3442

3543
Calls a `get_root_meta` function on a serializer, if it exists.
3644

37-
#### build_json_resource_obj(fields, resource, resource_instance, resource_name)
45+
#### build_json_resource_obj
46+
47+
`build_json_resource_obj(fields, resource, resource_instance, resource_name)g
3848

3949
Builds the resource object (type, id, attributes) and extracts relationships.
4050

0 commit comments

Comments
 (0)