Package com.mediumapi.apiclient

Interface SearchApi

public interface SearchApi

  • Method Summary

    Modifier and Type
    Method
    Description
    default SearchApiClient
    getDelegate()
     
    default org.springframework.http.ResponseEntity<MediumSearchArticles>
    searchArticlesGet(@NotNull @Valid String query)
    GET /search/articles : Search Articles Returns the list of `articles_ids` for the given search query results.
    default org.springframework.http.ResponseEntity<MediumSearchLists>
    searchListsGet(@NotNull @Valid String query)
    GET /search/lists : Search Lists Returns an array of `list_ids` for the given search query results.
    default org.springframework.http.ResponseEntity<MediumSearchPublications>
    searchPublicationsGet(@NotNull @Valid String query)
    GET /search/publications : Search Publications Returns the list of `publication_ids` for the given search query results.
    default org.springframework.http.ResponseEntity<MediumSearchTags>
    searchTagsGet(@NotNull @Valid String query)
    GET /search/tags : Search Tags Returns a list of `tags` for the given search query results.
    default org.springframework.http.ResponseEntity<MediumSearchUsers>
    searchUsersGet(@NotNull @Valid String query)
    GET /search/users : Search Users Returns a list of `user_ids` for the given search query results.

  • Method Details

    • getDelegate

      default SearchApiClient getDelegate()

    • searchArticlesGet

      @RequestMapping(method=GET, value="/search/articles", produces="application/json") default org.springframework.http.ResponseEntity<MediumSearchArticles> searchArticlesGet(@NotNull @Valid @RequestParam(value="query",required=true) @NotNull @Valid String query)
      GET /search/articles : Search Articles Returns the list of `articles_ids` for the given search query results. (Max Length = 1000)
      Parameters:
      query - Search query (required)
      Returns:
      OK (status code 200)

    • searchListsGet

      @RequestMapping(method=GET, value="/search/lists", produces="application/json") default org.springframework.http.ResponseEntity<MediumSearchLists> searchListsGet(@NotNull @Valid @RequestParam(value="query",required=true) @NotNull @Valid String query)
      GET /search/lists : Search Lists Returns an array of `list_ids` for the given search query results. (Max Length = 1000)
      Parameters:
      query - Search query (required)
      Returns:
      OK (status code 200)

    • searchPublicationsGet

      @RequestMapping(method=GET, value="/search/publications", produces="application/json") default org.springframework.http.ResponseEntity<MediumSearchPublications> searchPublicationsGet(@NotNull @Valid @RequestParam(value="query",required=true) @NotNull @Valid String query)
      GET /search/publications : Search Publications Returns the list of `publication_ids` for the given search query results. (Max Length = 1000)
      Parameters:
      query - Search query (required)
      Returns:
      OK (status code 200)

    • searchTagsGet

      @RequestMapping(method=GET, value="/search/tags", produces="application/json") default org.springframework.http.ResponseEntity<MediumSearchTags> searchTagsGet(@NotNull @Valid @RequestParam(value="query",required=true) @NotNull @Valid String query)
      GET /search/tags : Search Tags Returns a list of `tags` for the given search query results. (Max Length = 1000)
      Parameters:
      query - Search query (required)
      Returns:
      OK (status code 200)

    • searchUsersGet

      @RequestMapping(method=GET, value="/search/users", produces="application/json") default org.springframework.http.ResponseEntity<MediumSearchUsers> searchUsersGet(@NotNull @Valid @RequestParam(value="query",required=true) @NotNull @Valid String query)
      GET /search/users : Search Users Returns a list of `user_ids` for the given search query results. (Max Length = 1000)
      Parameters:
      query - Search query (required)
      Returns:
      OK (status code 200)