This repository has been archived by the owner on Dec 14, 2018. It is now read-only.
Added new attribute ProducesResponseTypeAttribute to enable ApiExplor… #4269
Conversation
This file contains 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
| /// Will be null if the action returns no response, or if the response type is unclear. Use | ||
| /// <c>ProducesAttribute</c> on an action method to specify a response type. | ||
| /// </remarks> | ||
| public Type ResponseType { get; set; } |
There was a problem hiding this comment.
Let's change this to just Type and ModelMetadata for consistency with https://github.com/aspnet/Mvc/blob/dev/src/Microsoft.AspNetCore.Mvc.ApiExplorer/ApiParameterDescription.cs
|
this is overall looking good ⌚ |
kichalla
force-pushed
the
kiran/responsetype
branch
6 times, most recently
from
3a7c44b to
f41a511
Compare
|
🆙 📅 |
| // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| using Microsoft.AspNetCore.Mvc.Formatters; | ||
|
|
||
| namespace Microsoft.AspNetCore.Mvc.ApiExplorer | ||
| { | ||
| /// <summary> | ||
| /// Represents a possible format for the body of a response. | ||
| /// </summary> | ||
| public class ApiResponseFormat |
| var responseType = Assert.Single(description.SupportedResponseTypes | ||
| .Where(respData => respData.ResponseType == type && respData.StatusCode == 200)); | ||
| Assert.Equal(4, responseType.ResponseFormats.Count); | ||
| Assert.Single(responseType.ResponseFormats, frmt => frmt.MediaType == "text/json"); |
|
Looking overall good, lots of little cleanup things to do ⌚ |
| public int StatusCode { get; set; } | ||
|
|
||
| /// <inheritdoc /> | ||
| public void SetContentTypes(MediaTypeCollection contentTypes) |
There was a problem hiding this comment.
Why do we need to implement this at all? I understand that it causes no harm, but it's confusing that it has this here.
There was a problem hiding this comment.
ApiExplorer would currently look for IApitResponseMetadataProvider and probably you are suggesting to break this interface up into 2?
There was a problem hiding this comment.
Could we make it an explicit implementation just so it doesn't show up in the regular API surface?
kichalla
force-pushed
the
kiran/responsetype
branch
5 times, most recently
from
eb1d3dd to
bef2a4f
Compare
|
🆙 📅 |
| @@ -6,18 +6,18 @@ | |||
| namespace Microsoft.AspNetCore.Mvc.ApiExplorer | |||
| { | |||
| /// <summary> | |||
| /// Represents a possible format for the body of a response. | |||
| /// Possible format for an <see cref="ApiResponseType"/>. | |||
|
⌚ |
kichalla
force-pushed
the
kiran/responsetype
branch
2 times, most recently
from
80b0069 to
0637080
Compare
| /// Gets or sets the CLR data type of the response or null. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Will be null if the action returns no response, or if the response type is unclear. Use |
|
|
when
|
|
…er to expose response type and StatusCode. [Fixes #4101] StatusCode Metadata
kichalla
force-pushed
the
kiran/responsetype
branch
from
0637080 to
3670144
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
…er to expose response type and StatusCode.
[Fixes #4101] StatusCode Metadata
@rynowak