Package io.github.kaposke.http

Interface DocClient

All Known Implementing Classes:

DocService

public interface DocClient

Method Summary

Modifier and Type	Method	Description
DocResponse	approve(String previewSlug)
DocCreatedResponse	create(CreateDocRequest input)
List<DocResponse>	findDocs(float offset, float limit, float artifactId)
List<DocResponse>	getAllApprovedByOrgSlugAndApiSlug(String orgSlug, String apiSlug, String apiVersion)
DocResponse	getApprovedByOrgSlugAndApiSlug(String orgSlug, String apiSlug, String apiVersion)
DocResponse	getById(float id)
DocResponse	remove(float id)
DocResponse	update(UpdateDocRequest input, float id)

Method Details

getApprovedByOrgSlugAndApiSlug

DocResponse getApprovedByOrgSlugAndApiSlug(String orgSlug,
 String apiSlug,
 String apiVersion)
                                    throws ApiException

Throws:

ApiException

getAllApprovedByOrgSlugAndApiSlug

List<DocResponse> getAllApprovedByOrgSlugAndApiSlug(String orgSlug,
 String apiSlug,
 String apiVersion)
                                             throws ApiException

Throws:

ApiException

findDocs

List<DocResponse> findDocs(float offset,
 float limit,
 float artifactId)
                    throws ApiException

Throws:

ApiException

create

DocCreatedResponse create(CreateDocRequest input)
                   throws ApiException

Throws:

ApiException

approve

DocResponse approve(String previewSlug)
             throws ApiException

Throws:

ApiException

getById

DocResponse getById(float id)
             throws ApiException

Throws:

ApiException

update

DocResponse update(UpdateDocRequest input,
 float id)
            throws ApiException

Throws:

ApiException

remove

DocResponse remove(float id)
            throws ApiException

Throws:

ApiException