Skip to main content

Hints API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
hintsCreateNewHintPOST /hints/create/hints/create [POST]
hintsDeleteSpecificHintPOST /hints/{hint}/delete/hints/{hint}/delete [POST]
hintsSnapshotGET /hints/hints [GET]

hintsCreateNewHint

Hint hintsCreateNewHint(seededHint)

/hints/create [POST]

This will create a hint.

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = HintsApi()
val seededHint : SeededHint = // SeededHint |
try {
val result : Hint = apiInstance.hintsCreateNewHint(seededHint)
println(result)
} catch (e: ClientException) {
println("4xx response calling HintsApi#hintsCreateNewHint")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HintsApi#hintsCreateNewHint")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
seededHintSeededHint[optional]

Return type

Hint

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

hintsDeleteSpecificHint

hintsDeleteSpecificHint(hint)

/hints/{hint}/delete [POST]

This will delete a specific hint.

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = HintsApi()
val hint : kotlin.String = hint_example // kotlin.String | This is a specific hint uuid
try {
apiInstance.hintsDeleteSpecificHint(hint)
} catch (e: ClientException) {
println("4xx response calling HintsApi#hintsDeleteSpecificHint")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HintsApi#hintsDeleteSpecificHint")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
hintkotlin.StringThis is a specific hint uuid

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

hintsSnapshot

Hints hintsSnapshot()

/hints [GET]

This will get a snapshot of all of the hints.

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = HintsApi()
try {
val result : Hints = apiInstance.hintsSnapshot()
println(result)
} catch (e: ClientException) {
println("4xx response calling HintsApi#hintsSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling HintsApi#hintsSnapshot")
e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

Hints

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json