MH-13018 re-add recordings json to 5x (includes MH-12828 re-add conflicts.json) #367
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
staubesv
suggested changes
Aug 13, 2018
| Date end = new DateTime(endDate).toDateTime(DateTimeZone.UTC).toDate(); | ||
| @GET | ||
| @Produces(MediaType.TEXT_XML) | ||
| @Path("conflicts.xml") |
There was a problem hiding this comment.
Hmm... would you be willing to also do a @path("recordings.{type:xml|json}")-style here (instead of adding a second method)? Seems that avoids all the overhead of the REST docs and reduces code duplcation...
|
@karendolan Please note that I'm waiting on you to answer the "Would you be willing..."-question in the older comment... |
|
Hi @staubesv ! Thank you for the ping. I am willing and able (back from vacation now) |
added 3 commits
August 27, 2018 10:37
…conflicts json REST endpoint (includes peer review to continue throwing UnauthorizedException)
karendolan
force-pushed
the
t/MH12828-MH13018-conflictsJSON-recordingsJSON-5x
branch
from
c476fcc
to
5f4b5ae
Compare
staubesv
reviewed
Aug 28, 2018
| @Path("conflicts.{type:xml|json}") | ||
| @RestQuery(name = "conflictingrecordings", description = "Searches for conflicting recordings based on parameters and returns result as XML or JSON", returnDescription = "Returns NO CONTENT if no recordings are in conflict within specified period or list of conflicting recordings in XML or JSON", | ||
| pathParameters = { | ||
| @RestParameter(name = "type", isRequired = true, description = "The media type of the response [xml|json]", defaultValue = "xml", type = Type.STRING), }, |
There was a problem hiding this comment.
Please remove "defaultValue", it is confusing:
There was a problem hiding this comment.
Also: Superfluous comma on this line: [...] type = Type.STRING), },
staubesv
reviewed
Aug 28, 2018
| @Path("recordings.{type:xml|json}") | ||
| @RestQuery(name = "recordingsaslist", description = "Searches recordings and returns result as XML or JSON", returnDescription = "XML or JSON formated results", | ||
| pathParameters = { | ||
| @RestParameter(name = "type", isRequired = true, description = "The media type of the response [xml|json]", defaultValue = "xml", type = Type.STRING), }, |
There was a problem hiding this comment.
Please remove "defaultValue" for this mandatory parameter
karendolan
force-pushed
the
t/MH12828-MH13018-conflictsJSON-recordingsJSON-5x
branch
from
538bae9
to
20810ed
Compare
staubesv
approved these changes
Aug 28, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull for MH-13018 to readd recordings.json, also includes as a prerequisite the MH-12828 pulll that was merged to OC develop branch in https://github.com/opencast/opencast/pull/233/files. Both fixes use the getEventListAsJsonString() helper that is reused by both conflicts.json and recordings.json. Adding both here should make it easier to merge back this fix to develop branch.
The conflicts code is not altered in this pull, but it is moved into a helper method to avoid duplication.
Example result of /recordings/recordings.json?...
{
"totalCount": "0",
"events": []
}
or
{ "totalCount": "2",
"events": [
{
"seriestitle": "Test Spring 2018 (29996)",
"metadata": {"catalog": [... ]},
"attachments": {"attachment": [...]},
"series": 20180229996,
"start": "2018-07-30T18:00:00Z",
"id": "877067ba-857d-4527-980b-88f576764f5b",
"media": "",
"title": "Karen test schdule Jul 30 -2",
"type": "L02",
"publications": ""
},
{
"seriestitle": "Computer Science 101 (29990) Spring 2018",
"metadata": {"catalog": [...]},
"attachments": {"attachment": [...]},
"series": 20180229990,
"creators": {"creator": "kdolan"},
"start": "2018-08-05T18:00:00Z",
"id": "e5d89b64-73ff-4287-98ad-a5040f5228a6",
"media": "",
"title": "Karen test schdule Jul 30 -1",
"type": "L01",
"publications": {"publication": {...}}
}
]
}