Skip to content

updated documentation for typed json output #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mooreds wants to merge 1 commit into
base: master
Choose a base branch
from
Open

updated documentation for typed json output #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions WebContent/doc/Concepts.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,19 +313,19 @@ <h2>HTTP Response</h2>
Content-Type: application/json

{ "actors": [
{ "last_name": "SMITH", "first_name": "JULIANNE", "actor_id": "201",
{ "last_name": "SMITH", "first_name": "JULIANNE", "actor_id": 201,
"films": [
{ "year": "2006", "title": "ACADEMY DINOSAUR", "film_id": "1" },
{ "year": "2006", "title": "ADAPTATION HOLES", "film_id": "3" },
{ "year": "2006", "title": "ANACONDA CONFESSIONS", "film_id": "23" }
{ "year": 2006, "title": "ACADEMY DINOSAUR", "film_id": 1 },
{ "year": 2006, "title": "ADAPTATION HOLES", "film_id": 3 },
{ "year": 2006, "title": "ANACONDA CONFESSIONS", "film_id": 23 }
]
},
{ "last_name": "SMITH", "first_name": "PATRICK", "actor_id": "205",
{ "last_name": "SMITH", "first_name": "PATRICK", "actor_id": 205,
"films": [
{ "year": "2006", "title": "APACHE DIVINE", "film_id": "31" },
{ "year": "2006", "title": "BABY HALL", "film_id": "47" },
{ "year": "2006", "title": "BULL SHAWSHANK", "film_id": "105" },
{ "year": "2006", "title": "CHAINSAW UPTOWN", "film_id": "132" }
{ "year": 2006, "title": "APACHE DIVINE", "film_id": 31 },
{ "year": 2006, "title": "BABY HALL", "film_id": 47 },
{ "year": 2006, "title": "BULL SHAWSHANK", "film_id": 105 },
{ "year": 2006, "title": "CHAINSAW UPTOWN", "film_id": 132 }
]
}
}
Expand Down Expand Up @@ -384,4 +384,4 @@ <h2>Attribute Validator (Planned Feature)</h2>
<p class="text">Custom Java-based attribute validators may be deployed to enforce more complex domain logic. The design of this feature is pending.</p>
</div>
</body>
</html>
</html>
8 changes: 4 additions & 4 deletions WebContent/doc/ref/ResDeletePath.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h2>JSON Examples</h2>
<pre>HTTP/1.1 200 OK
Content-Type: application/json

{ "rowsAffected": "1" }</pre>
{ "rowsAffected": 1 }</pre>

<div class="text">A delete to parents and children of a one-to-many hierarchical SQL Resource:</div>
<pre>DELETE /restsql/res/LanguageFilm/3 HTTP/1.1
Expand All @@ -126,7 +126,7 @@ <h2>JSON Examples</h2>
<pre>HTTP/1.1 200 OK
Content-Type: application/json

{ "rowsAffected": "13" }</pre>
{ "rowsAffected": 13 }</pre>

<div class="text">A delete to parents of a many-to-many hierarchical SQL Resource (parent rows are deleted, and child rows are disassociated):</div>
<pre>DELETE /restsql/res/ActorFilm/123 HTTP/1.1
Expand All @@ -136,7 +136,7 @@ <h2>JSON Examples</h2>
<pre>HTTP/1.1 200 OK
Content-Type: application/json

{ "rowsAffected": "9" }</pre>
{ "rowsAffected": 9 }</pre>
</div>
</body>
</html>
</html>
18 changes: 9 additions & 9 deletions WebContent/doc/ref/ResDeletePathXmlOrJson.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,35 +117,35 @@ <h2>JSON Examples</h2>
Accept: application/json

{ "films": [
{ "film_id": "3" },
{ "film_id": "43" },
{ "film_id": "67" },
{ "film_id": 3 },
{ "film_id": 43 },
{ "film_id": 67 },
]
}
</pre>

<pre>HTTP/1.1 200 OK
Content-Type: application/json

{ "rowsAffected": "3" }</pre>
{ "rowsAffected": 3 }</pre>

<div class="text">A many-to-many hierarchical SQL Resource (child rows are disassociated):</div>
<pre>DELETE /restsql/res/ActorFilm/123 HTTP/1.1
Content-Type: application/json
Accept: application/json

{ "films": [
{ "film_id": "3" },
{ "film_id": "43" },
{ "film_id": "233" },
{ "film_id": 3 },
{ "film_id": 43 },
{ "film_id": 233 },
]
}
</pre>

<pre>HTTP/1.1 200 OK
Content-Type: application/json

{ "rowsAffected": "3" }</pre>
{ "rowsAffected": 3 }</pre>
</div>
</body>
</html>
</html>
8 changes: 4 additions & 4 deletions WebContent/doc/ref/ResDeleteQuery.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h2>JSON Examples</h2>
<pre>HTTP/1.1 200 OK
Content-Type: application/json

{ "rowsAffected": "3" }</pre>
{ "rowsAffected": 3 }</pre>

<div class="text">A delete to parents of a one-to-many hierarchical SQL Resource (child rows are also deleted):</div>
<pre>DELETE /restsql/res/LanguageFilm/3 HTTP/1.1
Expand All @@ -127,7 +127,7 @@ <h2>JSON Examples</h2>
<pre>HTTP/1.1 200 OK
Content-Type: application/json

{ "rowsAffected": "18" }</pre>
{ "rowsAffected": 18 }</pre>

<div class="text">A delete to parents of a many-to-many hierarchical SQL Resource (parent rows are deleted, and child rows are disassociated):</div>
<pre>DELETE /restsql/res/ActorFilm?last_name=DENCH HTTP/1.1
Expand All @@ -137,7 +137,7 @@ <h2>JSON Examples</h2>
<pre>HTTP/1.1 200 OK
Content-Type: application/json

{ "rowsAffected": "9" }</pre>
{ "rowsAffected": 9 }</pre>
</div>
</body>
</html>
</html>
34 changes: 17 additions & 17 deletions WebContent/doc/ref/ResDeleteXmlOrJson.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,25 +160,25 @@ <h2>JSON Examples</h2>
Accept: application/json

{ "actors": [
{ "actor_id": "123", "first_name": "JULIANNE", "surname": "DENCH" },
{ "actor_id": "124", "first_name": "SCARLETT", "surname": "BENING" },
{ "actor_id": "125", "first_name": "ALBERT", "surname": "NOLTE" }
{ "actor_id": 123, "first_name": "JULIANNE", "surname": "DENCH" },
{ "actor_id": 124, "first_name": "SCARLETT", "surname": "BENING" },
{ "actor_id": 125, "first_name": "ALBERT", "surname": "NOLTE" }
[
}
</pre>
<pre>HTTP/1.1 200 OK
Content-Type: application/json

{ "rowsAffected": "3" }</pre>
{ "rowsAffected": 3 }</pre>

<div class="text">A delete to parents and children of a one-to-many hierarchical SQL Resource:</div>
<pre>DELETE /restsql/res/LanguageFilm HTTP/1.1
Content-Type: application/json
Accept: application/json

{ "languages": [
{ "language_id": "2" },
{ "language_id": "3" }
{ "language_id": 2 },
{ "language_id": 3 }
[
}
</pre>
Expand All @@ -194,17 +194,17 @@ <h2>JSON Examples</h2>
Accept: application/json

{ "languages": [
{ "language_id": "1",
{ "language_id": 1,
"films": [
{ "film_id": "3" },
{ "film_id": "43" },
{ "film_id": "67" }
{ "film_id": 3 },
{ "film_id": 43 },
{ "film_id": 67 }
]
},
{ "language_id": "2"
{ "language_id": 2
"films": [
{ "film_id": "3" },
{ "film_id": "43" }
{ "film_id": 3 },
{ "film_id": 43 }
]
}
[
Expand All @@ -222,16 +222,16 @@ <h2>JSON Examples</h2>
Accept: application/json

{ "actors": [
{ "actor_id": "123" },
{ "actor_id": "124" }
{ "actor_id": 123 },
{ "actor_id": 124 }
[
}
</pre>

<pre>HTTP/1.1 200 OK
Content-Type: application/json

{ "rowsAffected": "18" }</pre>
{ "rowsAffected": 18 }</pre>
</div>
</body>
</html>
</html>
16 changes: 8 additions & 8 deletions WebContent/doc/ref/ResGetPath.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h2>JSON Examples</h2>
Content-Type: application/json

{ "actors": [
{ "id": "123", "first_name": "JULIANNE", "surname": "DENCH" }
{ "id": 123, "first_name": "JULIANNE", "surname": "DENCH" }
]
}
</pre>
Expand All @@ -125,13 +125,13 @@ <h2>JSON Examples</h2>
Content-Type: application/json

{ "actors": [
{ "id": "123", "first_name": "JULIANNE", "surname": "DENCH" },
{ "id": 123, "first_name": "JULIANNE", "surname": "DENCH" },
"films": [
{ "year": "2006", "title": "ADAPTATION HOLES", "film_id": "3" },
{ "year": "2006", "title": "ATLANTIS CAUSE", "film_id": "43" },
{ "year": "2006", "title": "BERETS AGENT", "film_id": "67" },
{ "year": "2006", "title": "BULL SHAWSHANK", "film_id": "105" },
{ "year": "2006", "title": "CHOCOLATE DUCK", "film_id": "138" },
{ "year": 2006, "title": "ADAPTATION HOLES", "film_id": 3 },
{ "year": 2006, "title": "ATLANTIS CAUSE", "film_id": 43 },
{ "year": 2006, "title": "BERETS AGENT", "film_id": 67 },
{ "year": 2006, "title": "BULL SHAWSHANK", "film_id": 105 },
{ "year": 2006, "title": "CHOCOLATE DUCK", "film_id": 138 },
]
}
]
Expand All @@ -145,4 +145,4 @@ <h2>JSON Examples</h2>

</div>
</body>
</html>
</html>
64 changes: 32 additions & 32 deletions WebContent/doc/ref/ResGetQuery.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ <h2>JSON Examples</h2>
Content-Type: application/json

{ "actors": [
{ "actor_id": "123", "first_name": "JULIANNE", "surname": "DENCH" }
{ "actor_id": 123, "first_name": "JULIANNE", "surname": "DENCH" }
]
}
</pre>
Expand All @@ -185,15 +185,15 @@ <h2>JSON Examples</h2>
Content-Type: application/json

{ "actors": [
{ "actor_id": "180", "first_name": "JEFF", "surname": "SILVERSTONE" },
{ "actor_id": "195", "first_name": "JAYNE", "surname": "SILVERSTONE" }
{ "actor_id": "78", "first_name": "GROUCHO", "surname": "SINATRA" },
{ "actor_id": "31", "first_name": "SISSY", "surname": "SOBIESKI" },
{ "actor_id": "44", "first_name": "NICK", "surname": "STALLONE" },
{ "actor_id": "24", "first_name": "CAMERON", "surname": "STREEP" },
{ "actor_id": "116", "first_name": "DAN", "surname": "STREEP" },
{ "actor_id": "192", "first_name": "JOHN", "surname": "SUVARI" },
{ "actor_id": "9", "first_name": "JOE", "surname": "SWANK" },
{ "actor_id": 180, "first_name": "JEFF", "surname": "SILVERSTONE" },
{ "actor_id": 195, "first_name": "JAYNE", "surname": "SILVERSTONE" }
{ "actor_id": 78, "first_name": "GROUCHO", "surname": "SINATRA" },
{ "actor_id": 31, "first_name": "SISSY", "surname": "SOBIESKI" },
{ "actor_id": 44, "first_name": "NICK", "surname": "STALLONE" },
{ "actor_id": 24, "first_name": "CAMERON", "surname": "STREEP" },
{ "actor_id": 116, "first_name": "DAN", "surname": "STREEP" },
{ "actor_id": 192, "first_name": "JOHN", "surname": "SUVARI" },
{ "actor_id": 9, "first_name": "JOE", "surname": "SWANK" },
]
}
</pre>
Expand All @@ -205,16 +205,16 @@ <h2>JSON Examples</h2>
Content-Type: application/json

{ "actors": [
{ "actor_id": "1", "first_name": "PENELOPE", "surname": "GUINESS" },
{ "actor_id": "2", "first_name": "NICK", "surname": "WAHLBERG" },
{ "actor_id": "3", "first_name": "ED", "surname": "CHASE" },
{ "actor_id": "4", "first_name": "JENNIFER", "surname": "DAVIS" },
{ "actor_id": "5", "first_name": "JOHNNY", "surname": "LOLLOBRIGIDA" },
{ "actor_id": "6", "first_name": "BETTE", "surname": "NICHOLSON" },
{ "actor_id": "7", "first_name": "GRACE", "surname": "MOSTEL" },
{ "actor_id": "8", "first_name": "MATTHEW", "surname": "JOHANSSON" },
{ "actor_id": "9", "first_name": "JOE", "surname": "SWANK" },
{ "actor_id": "10", "first_name": "CHRISTIAN", "surname": "GABLE" }
{ "actor_id": 1, "first_name": "PENELOPE", "surname": "GUINESS" },
{ "actor_id": 2, "first_name": "NICK", "surname": "WAHLBERG" },
{ "actor_id": 3, "first_name": "ED", "surname": "CHASE" },
{ "actor_id": 4, "first_name": "JENNIFER", "surname": "DAVIS" },
{ "actor_id": 5, "first_name": "JOHNNY", "surname": "LOLLOBRIGIDA" },
{ "actor_id": 6, "first_name": "BETTE", "surname": "NICHOLSON" },
{ "actor_id": 7, "first_name": "GRACE", "surname": "MOSTEL" },
{ "actor_id": 8, "first_name": "MATTHEW", "surname": "JOHANSSON" },
{ "actor_id": 9, "first_name": "JOE", "surname": "SWANK" },
{ "actor_id": 10, "first_name": "CHRISTIAN", "surname": "GABLE" }
]
}
</pre>
Expand All @@ -226,13 +226,13 @@ <h2>JSON Examples</h2>
Content-Type: application/json

{ "actors": [
{ "actor_id": "123", "first_name": "JULIANNE", "surname": "DENCH" },
{ "actor_id": 123, "first_name": "JULIANNE", "surname": "DENCH" },
"films": [
{ "year": "2006", "title": "ADAPTATION HOLES", "film_id": "3" },
{ "year": "2006", "title": "ATLANTIS CAUSE", "film_id": "43" },
{ "year": "2006", "title": "BERETS AGENT", "film_id": "67" },
{ "year": "2006", "title": "BULL SHAWSHANK", "film_id": "105" },
{ "year": "2006", "title": "CHOCOLATE DUCK", "film_id": "138" },
{ "year": 2006, "title": "ADAPTATION HOLES", "film_id": 3 },
{ "year": 2006, "title": "ATLANTIS CAUSE", "film_id": 43 },
{ "year": 2006, "title": "BERETS AGENT", "film_id": 67 },
{ "year": 2006, "title": "BULL SHAWSHANK", "film_id": 105 },
{ "year": 2006, "title": "CHOCOLATE DUCK", "film_id": 138 },
]
}
]
Expand All @@ -246,11 +246,11 @@ <h2>JSON Examples</h2>
Content-Type: application/json

{ "actors": [
{ "actor_id": "147", "first_name": "FAY", "surname": "WINSLET" },
{ "actor_id": "156", "first_name": "FAY", "surname": "WOOD" },
{ "actor_id": "164", "first_name": "HUMPHREY", "surname": "WILLIS" },
{ "actor_id": "168", "first_name": "WILL", "surname": "WILSON" },
{ "actor_id": "186", "first_name": "JULIA", "surname": "ZELLWEGER" }
{ "actor_id": 147, "first_name": "FAY", "surname": "WINSLET" },
{ "actor_id": 156, "first_name": "FAY", "surname": "WOOD" },
{ "actor_id": 164, "first_name": "HUMPHREY", "surname": "WILLIS" },
{ "actor_id": 168, "first_name": "WILL", "surname": "WILSON" },
{ "actor_id": 186, "first_name": "JULIA", "surname": "ZELLWEGER" }
]
}
</pre>
Expand All @@ -263,4 +263,4 @@ <h2>JSON Examples</h2>

</div>
</body>
</html>
</html>
Loading