You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: spec/latest/json-ld-api-best-practices/index.html
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@
32
32
<body>
33
33
<sectionid='abstract'>
34
34
<p>
35
-
Developers share a common problem: they want a simple, but extensible way to create an API for a web service that gets the job done, doesn't design them into a corner, and allows developers to easily interact with their service without reinventing the wheel. JSON-LD [[JSON-LD]] has become an important solution, as it bridges the gap between formally data and more coloquial JSON interfaces used in APIs from numerous providers. This guide attempts to define certain best practices for publishing data using JSON-LD, and interacting with such services.
35
+
Developers share a common problem: they want a simple, but extensible way to create an API for a web service that gets the job done, doesn't design them into a corner, and allows developers to easily interact with their service without reinventing the wheel. JSON-LD [[JSON-LD]] has become an important solution, as it bridges the gap between formally data and more colloquial JSON interfaces used in APIs from numerous providers. This guide attempts to define certain best practices for publishing data using JSON-LD, and interacting with such services.
<p>Expanded form is not useful as is, but is necessary for performing further algorithmic transformaions of JSON-LD data and is useful when validating that JSON-LD entity descriptions say what the publisher means.</p>
129
+
<p>Expanded form is not useful as is, but is necessary for performing further algorithmic transformations of JSON-LD data and is useful when validating that JSON-LD entity descriptions say what the publisher means.</p>
<p><spanid="top-level-object" class="practicelab">Use a top-level object</span></p>
140
-
<pclass="practicedesc">JSON documents may be in the form of a object, or an array of objects. For most purposes, develpers need a single entrypoint, so the JSON SHOULD be in the form of a single top-level object</p>
140
+
<pclass="practicedesc">JSON documents may be in the form of a object, or an array of objects. For most purposes, developers need a single entry point, so the JSON SHOULD be in the form of a single top-level object</p>
<p><spanid="typed-objects" class="practicelab">Provide one or more types for JSON objects</span></p>
155
155
<pclass="practicedesc">Principles of <a>Linked Data</a> dictate that messages SHOULD be self describing, which includes adding a <code>type</code> to such messages.</p>
156
-
<p>Many APIs use JSON messages where the type of information being conveyed is inferred from the retreaval endpoint. For example, when retrieving information about a Github Commit, you might see the following response:</p>
156
+
<p>Many APIs use JSON messages where the type of information being conveyed is inferred from the retrieval endpoint. For example, when retrieving information about a Github Commit, you might see the following response:</p>
0 commit comments