Package io.github.kaposke.services

Class DocService

java.lang.Object

io.github.kaposke.services.BaseService

io.github.kaposke.services.DocService

All Implemented Interfaces:

DocClient

public class DocService
extends BaseService
implements DocClient

Field Summary

Fields inherited from class io.github.kaposke.services.BaseService

httpClient

Constructor Summary

Constructors

Constructor	Description
DocService(okhttp3.OkHttpClient httpClient)

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)

Methods inherited from class io.github.kaposke.services.BaseService

execute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocService

public DocService(okhttp3.OkHttpClient httpClient)

Method Details

getApprovedByOrgSlugAndApiSlug

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

Specified by:

getApprovedByOrgSlugAndApiSlug in interface DocClient

Throws:

ApiException

getAllApprovedByOrgSlugAndApiSlug

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

Specified by:

getAllApprovedByOrgSlugAndApiSlug in interface DocClient

Throws:

ApiException

findDocs

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

Specified by:

findDocs in interface DocClient

Throws:

ApiException

create

public DocCreatedResponse create(CreateDocRequest input)
                          throws ApiException

Specified by:

create in interface DocClient

Throws:

ApiException

approve

public DocResponse approve(String previewSlug)
                    throws ApiException

Specified by:

approve in interface DocClient

Throws:

ApiException

getById

public DocResponse getById(float id)
                    throws ApiException

Specified by:

getById in interface DocClient

Throws:

ApiException

update

public DocResponse update(UpdateDocRequest input,
 float id)
                   throws ApiException

Specified by:

update in interface DocClient

Throws:

ApiException

remove

public DocResponse remove(float id)
                   throws ApiException

Specified by:

remove in interface DocClient

Throws:

ApiException