Interface CategoriesSPI


  • @Path("/wp")
    public interface CategoriesSPI
    Describes the Categories Wordpress API
    Since:
    0.0.1
    See Also:
    Categories API Reference
    • Method Detail

      • list

        @GET
        @Path("/v{apiVersion}/categories")
        @Produces("application/json")
        List<Category> list​(@PathParam("apiVersion")
                            String apiVersion,
                            @QueryParam("context")
                            Context context,
                            @QueryParam("page")
                            Integer page,
                            @QueryParam("per_page")
                            Integer perPage,
                            @QueryParam("search")
                            String search,
                            @QueryParam("exclude")
                            List<Integer> exclude,
                            @QueryParam("include")
                            List<Integer> include,
                            @QueryParam("order")
                            Order order,
                            @QueryParam("orderby")
                            CategoryOrderBy orderBy,
                            @QueryParam("hide_empty")
                            Boolean hideEmpty,
                            @QueryParam("parent")
                            Integer parent,
                            @QueryParam("post")
                            Integer post,
                            @QueryParam("slug")
                            String slug)
      • retrieve

        @GET
        @Path("/v{apiVersion}/categories/{id}")
        @Produces("application/json")
        Category retrieve​(@PathParam("apiVersion")
                          String apiVersion,
                          @PathParam("id")
                          int categoryId,
                          @QueryParam("context")
                          Context context)
      • create

        @POST
        @Path("/v{apiVersion}/categories/")
        @Produces("application/json")
        @Consumes("application/json")
        Category create​(@PathParam("apiVersion")
                        String apiVersion,
                        Category category)
      • update

        @POST
        @Path("/v{apiVersion}/categories/{id}")
        @Produces("application/json")
        @Consumes("application/json")
        Category update​(@PathParam("apiVersion")
                        String apiVersion,
                        @PathParam("id")
                        int categoryId,
                        Category category)
      • delete

        @DELETE
        @Path("/v{apiVersion}/categories/{id}")
        Category delete​(@PathParam("apiVersion")
                        String apiVersion,
                        @PathParam("id")
                        int categoryId,
                        @QueryParam("force")
                        boolean force)