Incorrect episode REST endpoint documentation

Steps to reproduce

The Episode Service REST Documentation states for
GET /episode.{format:xml|json}:

episodes(Default value=false): Whether to include this series episodes. This can be used in combination with "id" or "q".

This option makes obviously no sense in an enpoint for episodes. It also has no effect. I guess that someone originally copied the docs from the search endpoint and modified them but overlooked this option. It should be safe to just remove this documentation line.

Activity

Show:
Lars Kiesow
October 30, 2013, 10:33 AM
Greg Logan
October 30, 2013, 2:53 PM

Into r/1.4.1!

Greg Logan
October 30, 2013, 9:49 PM

Bah, I missed this since I assumed things compile:

[INFO] ------------------------------------------------------------------------
[INFO] Building matterhorn-episode-service-impl
[INFO] task-segment: [clean, install]
[INFO] ------------------------------------------------------------------------
[INFO] [clean:clean {execution: default-clean}]
[INFO] [checkstyle:check {execution: default}]
[INFO] Starting audit...
Audit done.

[INFO] [resources:resources {execution: default-resources}]
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 10 resources
[INFO] [compiler:compile {execution: default-compile}]
[INFO] Compiling 30 source files to /home/gdl420/matterhorn/upstream/modules/matterhorn-episode-service-impl/target/classes
[INFO] -------------------------------------------------------------
[ERROR] COMPILATION ERROR :
[INFO] -------------------------------------------------------------
[ERROR] /home/gdl420/matterhorn/upstream/modules/matterhorn-episode-service-impl/src/main/java/org/opencastproject/episode/endpoint/AbstractEpisodeServiceRestEndpoint.java:[245,81] error: cannot find symbol
[ERROR] @interface RestParameter
/home/gdl420/matterhorn/upstream/modules/matterhorn-episode-service-impl/src/main/java/org/opencastproject/episode/endpoint/AbstractEpisodeServiceRestEndpoint.java:[245,32] error: annotation RestParameter is missing value for the attribute description
[INFO] 2 errors
[INFO] -------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[ERROR] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Compilation failure

/home/gdl420/matterhorn/upstream/modules/matterhorn-episode-service-impl/src/main/java/org/opencastproject/episode/endpoint/AbstractEpisodeServiceRestEndpoint.java:[245,81] error: cannot find symbol
@interface RestParameter
/home/gdl420/matterhorn/upstream/modules/matterhorn-episode-service-impl/src/main/java/org/opencastproject/episode/endpoint/AbstractEpisodeServiceRestEndpoint.java:[245,32] error: annotation RestParameter is missing value for the attribute description

Doesn't appear to be way of reverting things in BB unfortunately.

Lars Kiesow
October 30, 2013, 10:19 PM
Greg Logan
October 31, 2013, 2:51 PM

Yep, looks good. Into r/1.4.1 with 33e0e62.

Fixed and reviewed

Assignee

Lars Kiesow

Reporter

Lars Kiesow

Severity

Incorrect Documentation

Tags (folksonomy)

None

Components

Fix versions

Affects versions

Priority

Minor
Configure