comment updates

src/API/CourseProviderInterface.php

@@ -11,16 +11,29 @@ use Dbp\Relay\CoreBundle\Pagination\Paginator;
 interface CourseProviderInterface
 {
     /**
+     * @param array $options Available options:
+     *                       * 'lang' ('de' or 'en')
+     *                       * LocalData::INCLUDE_PARAMETER_NAME
+     *
      * @throws ApiError
      */
     public function getCourseById(string $identifier, array $options = []): Course;
 
     /**
+     * @param array $options Available options:
+     *                       * 'lang' ('de' or 'en')
+     *                       * Course::SEARCH_PARAMETER_NAME (partial, case-insensitive text search on 'name' attribute)
+     *                       * LocalData::INCLUDE_PARAMETER_NAME
+     *                       * LocalData::QUERY_PARAMETER_NAME
+     *
      * @throws ApiError
      */
     public function getCourses(array $options = []): Paginator;
 
     /**
+     * @param array $options Available options:
+     *                       * 'lang' ('de' or 'en')
+     *
      * @throws ApiError
      */
     public function getAttendeesByCourse(string $courseId, array $options = []): Paginator;

src/Entity/Course.php

@@ -18,7 +18,7 @@ use Dbp\Relay\CoreBundle\LocalData\LocalDataAwareTrait;
  *             "openapi_context" = {
  *                 "tags" = {"BaseCourse"},
  *                 "parameters" = {
- *                     {"name" = "search", "in" = "query", "description" = "Search for a course", "type" = "string", "required" = false},
+ *                     {"name" = "search", "in" = "query", "description" = "Search filter (partial, case-insensitive text search on 'name' attribute)", "type" = "string", "required" = false},
  *                     {"name" = "lang", "in" = "query", "description" = "Language of result", "type" = "string", "enum" = {"de", "en"}, "example" = "de"},
  *                     {"name" = "queryLocal", "in" = "query", "description" = "Local query parameters to apply", "type" = "string"},
  *                     {"name" = "includeLocal", "in" = "query", "description" = "Local data attributes to include", "type" = "string", "example" = "BaseCourse.code,BaseCourse.numberOfCredits"},