/// <summary>
 /// Constructor.
 /// </summary>
 /// <param name="httpStatusCode">HTTP status code.</param>
 /// <param name="responseDescription">Response description.</param>
 /// <param name="responseExampleOption"><see cref="ResponseExampleOptions"/>.</param>
 /// <param name="responseExample">New example for response.</param>
 public ChangeResponseByHttpStatusCodeDocumentFilter(int httpStatusCode, string responseDescription, ResponseExampleOptions responseExampleOption, T responseExample)
 {
     this._httpStatusCode        = httpStatusCode;
     this._responseDescription   = responseDescription;
     this._responseExampleOption = responseExampleOption;
     this._responseExample       = responseExample;
 }
Exemple #2
0
 /// <summary>
 /// Change all responses by specific http status codes in OpenApi document.
 /// </summary>
 /// <typeparam name="T">Type of response example.</typeparam>
 /// <param name="swaggerGenOptions"><see cref="SwaggerGenOptions"/>.</param>
 /// <param name="httpStatusCode">HTTP status code.</param>
 /// <param name="responseDescription">Response description.</param>
 /// <param name="responseExampleOption"><see cref="ResponseExampleOptions"/>.</param>
 /// <param name="responseExample">New example for response.</param>
 /// <returns>
 /// Returns <see cref="SwaggerGenOptions"/>.
 /// </returns>
 public static SwaggerGenOptions ChangeAllResponsesByHttpStatusCode <T>(
     this SwaggerGenOptions swaggerGenOptions,
     HttpStatusCode httpStatusCode,
     string responseDescription = null,
     ResponseExampleOptions responseExampleOption = ResponseExampleOptions.None,
     T responseExample = default) where T : class
 {
     return(swaggerGenOptions.ChangeAllResponsesByHttpStatusCode((int)httpStatusCode, responseDescription, responseExampleOption, responseExample));
 }
Exemple #3
0
 /// <summary>
 /// Change all responses by specific http status codes in OpenApi document.
 /// </summary>
 /// <typeparam name="T">Type of response example.</typeparam>
 /// <param name="swaggerGenOptions"><see cref="SwaggerGenOptions"/>.</param>
 /// <param name="httpStatusCode">HTTP status code.</param>
 /// <param name="responseDescription">Response description.</param>
 /// <param name="responseExampleOption"><see cref="ResponseExampleOptions"/>.</param>
 /// <param name="responseExample">New example for response.</param>
 /// <returns>
 /// Returns <see cref="SwaggerGenOptions"/>.
 /// </returns>
 public static SwaggerGenOptions ChangeAllResponsesByHttpStatusCode <T>(
     this SwaggerGenOptions swaggerGenOptions,
     int httpStatusCode,
     string responseDescription = null,
     ResponseExampleOptions responseExampleOption = ResponseExampleOptions.None,
     T responseExample = default) where T : class
 {
     swaggerGenOptions.DocumentFilter <ChangeResponseByHttpStatusCodeDocumentFilter <T> >(httpStatusCode, responseDescription, responseExampleOption, responseExample);
     return(swaggerGenOptions);
 }