22
33namespace QAToolKit . Source . Swagger
44{
5+ /// <summary>
6+ /// Swagger options
7+ /// </summary>
58 public class SwaggerOptions
69 {
10+ /// <summary>
11+ /// Request filter for filtering out the swagger endpoints
12+ /// </summary>
713 internal RequestFilter RequestFilter { get ; private set ; }
14+ /// <summary>
15+ /// Key/value pairs of replacement values
16+ /// </summary>
817 internal ReplacementValue [ ] ReplacementValues { get ; private set ; }
18+ /// <summary>
19+ /// Is Swagger protected with Basic authentication?
20+ /// </summary>
921 internal bool UseBasicAuth { get ; private set ; } = false ;
22+ /// <summary>
23+ /// Use request filters?
24+ /// </summary>
1025 internal bool UseRequestFilter { get ; private set ; } = false ;
26+ /// <summary>
27+ /// Swagger basic authentication user name
28+ /// </summary>
1129 internal string UserName { get ; private set ; }
30+ /// <summary>
31+ /// Swagger basic authentication password
32+ /// </summary>
1233 internal string Password { get ; private set ; }
1334
35+ /// <summary>
36+ /// Add basic authentication
37+ /// </summary>
38+ /// <param name="userName"></param>
39+ /// <param name="password"></param>
40+ /// <returns></returns>
1441 public SwaggerOptions AddBasicAuthentication ( string userName , string password )
1542 {
1643 UseBasicAuth = true ;
@@ -19,13 +46,23 @@ public SwaggerOptions AddBasicAuthentication(string userName, string password)
1946 return this ;
2047 }
2148
49+ /// <summary>
50+ /// Use request filters
51+ /// </summary>
52+ /// <param name="requestFilter"></param>
53+ /// <returns></returns>
2254 public SwaggerOptions AddRequestFilters ( RequestFilter requestFilter )
2355 {
2456 UseRequestFilter = true ;
2557 RequestFilter = requestFilter ;
2658 return this ;
2759 }
2860
61+ /// <summary>
62+ /// Use replacement values
63+ /// </summary>
64+ /// <param name="replacementValues"></param>
65+ /// <returns></returns>
2966 public SwaggerOptions AddReplacementValues ( ReplacementValue [ ] replacementValues )
3067 {
3168 ReplacementValues = replacementValues ;
0 commit comments