mirror of
https://github.com/duplicati/duplicati.git
synced 2025-11-28 03:20:25 +08:00
2f0a5af416
The new API avoids using HTTP status codes and verbs. Added new structure for having a similar response envelope and pagination support for V2 calls. Added extensions to the systemInfo call so the client knows if the V2 methods are available.
109 lines
No EOL
4 KiB
C#
109 lines
No EOL
4 KiB
C#
// Copyright (C) 2025, The Duplicati Team
|
|
// https://duplicati.com, hello@duplicati.com
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
namespace Duplicati.WebserverCore.Dto.V2;
|
|
|
|
/// <summary>
|
|
/// The list folder content item DTO
|
|
/// </summary>
|
|
public sealed record SearchEntriesItemDto
|
|
{
|
|
/// <summary>
|
|
/// The fileset version the entry belongs to
|
|
/// </summary>
|
|
public required long Version { get; init; }
|
|
/// <summary>
|
|
/// The fileset time the entry belongs to
|
|
/// </summary>
|
|
public required DateTime Time { get; init; }
|
|
/// <summary>
|
|
/// The path of the entry
|
|
/// </summary>
|
|
public required string Path { get; init; }
|
|
/// <summary>
|
|
/// The size of the entry
|
|
/// </summary>
|
|
public required long Size { get; init; }
|
|
/// <summary>
|
|
/// True if the entry is a directory, false otherwise
|
|
/// </summary>
|
|
public required bool IsDirectory { get; init; }
|
|
/// <summary>
|
|
/// True if the entry is a symlink, false otherwise
|
|
/// </summary>
|
|
public required bool IsSymlink { get; init; }
|
|
/// <summary>
|
|
/// The last modified time of the entry
|
|
/// </summary>
|
|
public required DateTime LastModified { get; init; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// The list folder content response DTO
|
|
/// </summary>
|
|
public sealed record SearchEntriesResponseDto : PagedResponseEnvelope<SearchEntriesItemDto>
|
|
{
|
|
/// <summary>
|
|
/// Creates a new instance of the <see cref="SearchEntriesResponseDto"/> class
|
|
/// </summary>
|
|
/// <param name="error">The error message</param>
|
|
/// <param name="statusCode">The status code</param>
|
|
/// <returns>A new instance of the <see cref="SearchEntriesResponseDto"/> class</returns>
|
|
public static new SearchEntriesResponseDto Failure(string error, string statusCode) =>
|
|
new SearchEntriesResponseDto
|
|
{
|
|
Success = false,
|
|
Error = error,
|
|
StatusCode = statusCode,
|
|
Data = null,
|
|
PageInfo = null
|
|
};
|
|
|
|
/// <summary>
|
|
/// Creates a new instance of the <see cref="SearchEntriesResponseDto"/> class
|
|
/// </summary>
|
|
/// <param name="items">The result items</param>
|
|
/// <param name="page">The page of the result</param>
|
|
/// <param name="pageSize">The page size</param>
|
|
/// <param name="totalCount">The total count of items</param>
|
|
/// <returns>A new instance of the <see cref="SearchEntriesResponseDto"/> class</returns>
|
|
public static SearchEntriesResponseDto Create(
|
|
IEnumerable<SearchEntriesItemDto> items,
|
|
int page,
|
|
int pageSize,
|
|
long totalCount)
|
|
{
|
|
return new SearchEntriesResponseDto
|
|
{
|
|
Data = items,
|
|
Success = true,
|
|
StatusCode = "OK",
|
|
Error = null,
|
|
PageInfo = new PageInfo
|
|
{
|
|
Page = page,
|
|
PageSize = pageSize,
|
|
Total = totalCount,
|
|
Pages = (int)Math.Ceiling((double)totalCount / pageSize)
|
|
}
|
|
};
|
|
}
|
|
} |