KevinMidboe/immich
1
0
Fork 0
mirror of https://github.com/KevinMidboe/immich.git synced 2025-12-08 20:29:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(server): improve API specification (#1853)

Browse Source
This commit is contained in:
Michel Heusschen
2023-02-24 17:01:10 +01:00
committed by GitHub
parent da9b9c8c69
commit 9323cc76d9
41 changed files with 1690 additions and 396 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
mobile/openapi/doc/SystemConfigApi.md generated
View File

@@ -31,6 +31,10 @@ import 'package:openapi/api.dart';
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
final api_instance = SystemConfigApi();
@@ -51,7 +55,7 @@ This endpoint does not need any parameter.
### Authorization
[bearer](../README.md#bearer)
[bearer](../README.md#bearer), [cookie](../README.md#cookie)
### HTTP request headers
@@ -76,6 +80,10 @@ import 'package:openapi/api.dart';
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
final api_instance = SystemConfigApi();
@@ -96,7 +104,7 @@ This endpoint does not need any parameter.
### Authorization
[bearer](../README.md#bearer)
[bearer](../README.md#bearer), [cookie](../README.md#cookie)
### HTTP request headers
@@ -121,6 +129,10 @@ import 'package:openapi/api.dart';
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
final api_instance = SystemConfigApi();
@@ -141,7 +153,7 @@ This endpoint does not need any parameter.
### Authorization
[bearer](../README.md#bearer)
[bearer](../README.md#bearer), [cookie](../README.md#cookie)
### HTTP request headers
@@ -166,6 +178,10 @@ import 'package:openapi/api.dart';
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
final api_instance = SystemConfigApi();
final systemConfigDto = SystemConfigDto(); // SystemConfigDto |
@@ -190,7 +206,7 @@ Name | Type | Description | Notes
### Authorization
[bearer](../README.md#bearer)
[bearer](../README.md#bearer), [cookie](../README.md#cookie)
### HTTP request headers