HintsApi.md

core_openapi.api.HintsApi

Load the API package

import 'package:pieces_os_client/api.dart';

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

Method	HTTP request	Description
hintsCreateNewHint	POST /hints/create	/hints/create [POST]
hintsDeleteSpecificHint	POST /hints/{hint}/delete	/hints/{hint}/delete [POST]
hintsSnapshot	GET /hints	/hints [GET]

hintsCreateNewHint

Hint hintsCreateNewHint(seededHint)

/hints/create [POST]

This will create a hint.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = HintsApi();
final seededHint = SeededHint(); // SeededHint | 

try {
    final result = api_instance.hintsCreateNewHint(seededHint);
    print(result);
} catch (e) {
    print('Exception when calling HintsApi->hintsCreateNewHint: $e\n');
}

Parameters

Name	Type	Description	Notes
seededHint	SeededHint		[optional]

Return type

Hint

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hintsDeleteSpecificHint

hintsDeleteSpecificHint(hint)

/hints/{hint}/delete [POST]

This will delete a specific hint.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = HintsApi();
final hint = hint_example; // String | This is a specific hint uuid

try {
    api_instance.hintsDeleteSpecificHint(hint);
} catch (e) {
    print('Exception when calling HintsApi->hintsDeleteSpecificHint: $e\n');
}

Parameters

Name	Type	Description	Notes
hint	String	This is a specific hint uuid

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hintsSnapshot

Hints hintsSnapshot()

/hints [GET]

This will get a snapshot of all of the hints.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = HintsApi();

try {
    final result = api_instance.hintsSnapshot();
    print(result);
} catch (e) {
    print('Exception when calling HintsApi->hintsSnapshot: $e\n');
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]