aboutsummaryrefslogtreecommitdiff
path: root/BackEnd/Timeline/Models/Http/TokenController.cs
blob: a5cbba14aa27db1331ab0501e0ade9f11cb047ca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
using System.ComponentModel.DataAnnotations;
using Timeline.Controllers;

namespace Timeline.Models.Http
{
    /// <summary>
    /// Request model for <see cref="TokenController.Create(HttpCreateTokenRequest)"/>.
    /// </summary>
    public class HttpCreateTokenRequest
    {
        /// <summary>
        /// The username.
        /// </summary>
        public string Username { get; set; } = default!;
        /// <summary>
        /// The password.
        /// </summary>
        public string Password { get; set; } = default!;
        /// <summary>
        /// Optional token validation period. In days. If not specified, server will use a default one.
        /// </summary>
        [Range(1, 365)]
        public int? Expire { get; set; }
    }

    /// <summary>
    /// Response model for <see cref="TokenController.Create(HttpCreateTokenRequest)"/>.
    /// </summary>
    public class HttpCreateTokenResponse
    {
        /// <summary>
        /// The token created.
        /// </summary>
        public string Token { get; set; } = default!;
        /// <summary>
        /// The user owning the token.
        /// </summary>
        public HttpUser User { get; set; } = default!;
    }

    /// <summary>
    /// Request model for <see cref="TokenController.Verify(HttpVerifyTokenRequest)"/>.
    /// </summary>
    public class HttpVerifyTokenRequest
    {
        /// <summary>
        /// The token to verify.
        /// </summary>
        public string Token { get; set; } = default!;
    }

    /// <summary>
    /// Response model for <see cref="TokenController.Verify(HttpVerifyTokenRequest)"/>.
    /// </summary>
    public class HttpVerifyTokenResponse
    {
        /// <summary>
        /// The user owning the token.
        /// </summary>
        public HttpUser User { get; set; } = default!;
    }
}