self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-22 01:47:08 +02:00
Code Issues Releases Activity
2cf42e867c
immich/mobile/openapi/doc/APIKeyApi.md
Zack Pollard 5ad4e5b614
infra(server)!: fix typeorm asset entity relations (#1782) 
* fix: add correct relations to asset typeorm entity

* fix: add missing createdAt column to asset entity

* ci: run check to make sure generated API is up-to-date

* ci: cancel workflows that aren't for the latest commit in a branch

* chore: add fvm config for flutter
2023-02-19 16:44:53 +00:00

4.8 KiB
Generated
Raw Blame History

openapi.api.APIKeyApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method HTTP request Description
createKey POST /api-key
deleteKey DELETE /api-key/{id}
getKey GET /api-key/{id}
getKeys GET /api-key
updateKey PUT /api-key/{id}

createKey

APIKeyCreateResponseDto createKey(aPIKeyCreateDto)

Example

import 'package:openapi/api.dart';

final api_instance = APIKeyApi();
final aPIKeyCreateDto = APIKeyCreateDto(); // APIKeyCreateDto | 

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

Parameters

Name Type Description Notes
aPIKeyCreateDto APIKeyCreateDto

Return type

APIKeyCreateResponseDto

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]

deleteKey

deleteKey(id)

Example

import 'package:openapi/api.dart';

final api_instance = APIKeyApi();
final id = id_example; // String | 

try {
    api_instance.deleteKey(id);
} catch (e) {
    print('Exception when calling APIKeyApi->deleteKey: $e\n');
}

Parameters

Name Type Description Notes
id String

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

getKey

APIKeyResponseDto getKey(id)

Example

import 'package:openapi/api.dart';

final api_instance = APIKeyApi();
final id = id_example; // String | 

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

Parameters

Name Type Description Notes
id String

Return type

APIKeyResponseDto

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]

getKeys

List getKeys()

Example

import 'package:openapi/api.dart';

final api_instance = APIKeyApi();

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

Parameters

This endpoint does not need any parameter.

Return type

List

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]

updateKey

APIKeyResponseDto updateKey(id, aPIKeyUpdateDto)

Example

import 'package:openapi/api.dart';

final api_instance = APIKeyApi();
final id = id_example; // String | 
final aPIKeyUpdateDto = APIKeyUpdateDto(); // APIKeyUpdateDto | 

try {
    final result = api_instance.updateKey(id, aPIKeyUpdateDto);
    print(result);
} catch (e) {
    print('Exception when calling APIKeyApi->updateKey: $e\n');
}

Parameters

Name Type Description Notes
id String
aPIKeyUpdateDto APIKeyUpdateDto

Return type

APIKeyResponseDto

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]