Skip to content

FeedsApi.md

Latest commit

 

History

History
239 lines (175 loc) · 5.34 KB

FeedsApi.md

File metadata and controls

239 lines (175 loc) · 5.34 KB
Raw

FeedsApi

All URIs are relative to https://localhost

Method HTTP request Description
deleteFeed DELETE /feeds/{id} Delete a feed
findFeed GET /feeds/{id} Get basic information about a feed
postFeed POST /feeds Post a feed
reportFeed POST /feeds/{id}/reports Report a feed
updateFeed PUT /feeds/{id} Update a feed

deleteFeed

deleteFeed(id)

Delete a feed

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = FeedsApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Feed identifier.
try {
    apiInstance.deleteFeed(id)
} catch (e: ClientException) {
    println("4xx response calling FeedsApi#deleteFeed")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FeedsApi#deleteFeed")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal Feed identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

findFeed

Feed findFeed(id)

Get basic information about a feed

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = FeedsApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Feed identifier.
try {
    val result : Feed = apiInstance.findFeed(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FeedsApi#findFeed")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FeedsApi#findFeed")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal Feed identifier.

Return type

Feed

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

postFeed

FeedCreated postFeed(body)

Post a feed

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = FeedsApi()
val body : PostFeedBody =  // PostFeedBody | 
try {
    val result : FeedCreated = apiInstance.postFeed(body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FeedsApi#postFeed")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FeedsApi#postFeed")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
body PostFeedBody

Return type

FeedCreated

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

reportFeed

reportFeed(id, body)

Report a feed

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = FeedsApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Feed identifier.
val body : PostFeedReportBody =  // PostFeedReportBody | 
try {
    apiInstance.reportFeed(id, body)
} catch (e: ClientException) {
    println("4xx response calling FeedsApi#reportFeed")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FeedsApi#reportFeed")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal Feed identifier.
body PostFeedReportBody

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

updateFeed

updateFeed(id, body)

Update a feed

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = FeedsApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Feed identifier.
val body : PutFeedBody =  // PutFeedBody | 
try {
    apiInstance.updateFeed(id, body)
} catch (e: ClientException) {
    println("4xx response calling FeedsApi#updateFeed")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FeedsApi#updateFeed")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal Feed identifier.
body PutFeedBody

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined