-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Add public metadata types. #49068
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add public metadata types. #49068
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
967807d
Add public metadata types.
mitchdenny aeb1daf
Add produces metadata type (WIP).
mitchdenny 70b8f0c
Update usage of ProducesResponseTypeMetadata.
mitchdenny e587c72
Remove generated metadata types from RDG.
mitchdenny 750db63
Fix metadata type usage.
mitchdenny b9597ac
Explicitly provide typeof(void) argument.
mitchdenny 4e19d28
Fix Ok result namespaces.
mitchdenny 37d7d3c
Add XML doc comments for AcceptsMetadata constructor.
mitchdenny 09684af
Revert submodule change.
mitchdenny ca88f6b
Change submodule to be the same as main.
mitchdenny File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
74 changes: 74 additions & 0 deletions
74
src/Http/Http.Abstractions/src/Metadata/ProducesResponseTypeMetadata.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
|
||
using System.Linq; | ||
using Microsoft.AspNetCore.Http.Metadata; | ||
using Microsoft.Net.Http.Headers; | ||
|
||
namespace Microsoft.AspNetCore.Http; | ||
|
||
/// <summary> | ||
/// Specifies the type of the value and status code returned by the action. | ||
/// </summary> | ||
public sealed class ProducesResponseTypeMetadata : IProducesResponseTypeMetadata | ||
{ | ||
/// <summary> | ||
/// Initializes an instance of <see cref="ProducesResponseTypeMetadata"/>. | ||
/// </summary> | ||
/// <param name="statusCode">The HTTP response status code.</param> | ||
/// <param name="type">The <see cref="Type"/> of object that is going to be written in the response.</param> | ||
/// <param name="contentTypes">Content types supported by the response.</param> | ||
public ProducesResponseTypeMetadata(int statusCode, Type? type = null, string[]? contentTypes = null) | ||
{ | ||
this.StatusCode = statusCode; | ||
this.Type = type; | ||
|
||
if (contentTypes is null || contentTypes.Length == 0) | ||
{ | ||
this.ContentTypes = Enumerable.Empty<string>(); | ||
} | ||
else | ||
{ | ||
for (var i = 0; i < contentTypes.Length; i++) | ||
{ | ||
MediaTypeHeaderValue.Parse(contentTypes[i]); | ||
ValidateContentType(contentTypes[i]); | ||
} | ||
|
||
this.ContentTypes = contentTypes; | ||
} | ||
|
||
static void ValidateContentType(string type) | ||
{ | ||
if (type.Contains('*', StringComparison.OrdinalIgnoreCase)) | ||
{ | ||
throw new InvalidOperationException($"Could not parse '{type}'. Content types with wildcards are not supported."); | ||
} | ||
} | ||
} | ||
|
||
// Only for internal use where validation is unnecessary. | ||
private ProducesResponseTypeMetadata(int statusCode, Type? type, IEnumerable<string> contentTypes) | ||
{ | ||
Type = type; | ||
StatusCode = statusCode; | ||
ContentTypes = contentTypes; | ||
} | ||
|
||
/// <summary> | ||
/// Gets or sets the type of the value returned by an action. | ||
/// </summary> | ||
public Type? Type { get; private set; } | ||
|
||
/// <summary> | ||
/// Gets or sets the HTTP status code of the response. | ||
/// </summary> | ||
public int StatusCode { get; private set; } | ||
|
||
/// <summary> | ||
/// Gets or sets the content types associated with the response. | ||
/// </summary> | ||
public IEnumerable<string> ContentTypes { get; private set; } | ||
|
||
internal static ProducesResponseTypeMetadata CreateUnvalidated(Type? type, int statusCode, IEnumerable<string> contentTypes) => new(statusCode, type, contentTypes); | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.