Doug Bunting
7c22abea99
Bump NSwag and Swashbuckle package versions ( #12950 )
...
* Update NSwag URLs to current GitHub location
* Add solution for web-api-help-pages-using-swagger projects
* Bump NSwag and Swashbuckle package versions
- current and next versions
- will need to bump versions again to pick up latest Microsoft-provided features
* React to latest NSwag and Swashbuckle versions
- lots of renames and type changes (especially `string` -> `Uri`) in NSwag
- Swashbuckle now relies on Microsoft.OpenApi.Models
- disable OpenAPI doc generation in other .NET Core 2.0 project
* Remove unused namespaces
- NSwag and Swashbuckle now use common `Startup` namespaces such as Microsoft.AspNetCore.Builder
nit: sort `using`s
* remove extra comma
* Move solution file into samples folder
* Minor tweaks (#12980 )
2019-06-21 15:27:39 -05:00
Rick Anderson
9a8dbc1750
Update action-return-types.md ( #12657 )
2019-06-03 10:32:09 -10:00
Scott Addie
a8794c324f
Hide package installation prereq for 3.0 ( #12589 )
2019-05-30 13:26:43 -05:00
Scott Addie
1e5b8eaa62
fix build warning
2019-05-22 09:11:25 -05:00
Pranav K
b0c615a1de
Add docs about configuring Json formatters ( #11923 )
...
* Add docs about configuring Json formatters
Fixes https://github.com/aspnet/AspNetCore.Docs/issues/11838
* Update aspnetcore/web-api/advanced/formatting.md
Co-Authored-By: Scott Addie <10702007+scottaddie@users.noreply.github.com>
* Update aspnetcore/web-api/advanced/formatting.md
Co-Authored-By: Scott Addie <10702007+scottaddie@users.noreply.github.com>
* Update aspnetcore/web-api/advanced/formatting.md
Co-Authored-By: Scott Addie <10702007+scottaddie@users.noreply.github.com>
* Update aspnetcore/web-api/advanced/formatting.md
Co-Authored-By: Scott Addie <10702007+scottaddie@users.noreply.github.com>
* Update aspnetcore/web-api/advanced/formatting.md
Co-Authored-By: Scott Addie <10702007+scottaddie@users.noreply.github.com>
* Update aspnetcore/web-api/advanced/formatting.md
Co-Authored-By: Scott Addie <10702007+scottaddie@users.noreply.github.com>
* Apply suggestions from code review
Co-Authored-By: Scott Addie <10702007+scottaddie@users.noreply.github.com>
* Update details for JsonResult
* More JsonResult specific content
* minor edits
* Xml formatting
* minor edits
2019-05-22 09:07:28 -05:00
Tom Dykstra
d309fe4fa8
How to log automatic 400 responses ( #12315 )
...
* How to log automatic 400 responses
* change link-to-issue format
2019-05-07 08:49:01 -07:00
Scott Addie
77e6584f04
Merge staging into master ( #12296 )
...
* Remove repository (#12203 )
* Fix language specification in one code sample (#12225 )
* Refactor Blazor intro paragraph (#12223 )
* Cross-link Get Started and Razor class lib topics (#12228 )
* Update app insights section (#12234 )
* Make Azure providers more discoverable (#12247 )
* Blazor Get Started: Update preview SDK instruction
* Revert 3c4a22f
* Blazor Get Started: Preview SDK instruction (#12271 )
2019-05-06 10:25:47 -05:00
Luke Latham
217c6f3604
React to repo name change in repo links ( #12152 )
2019-04-24 14:04:39 -10:00
hamed mohammadi
39facdfc1a
Odata-security ( #12137 )
...
* Adding Project files
* Updating startup cs
* adding todoitem
* todo context
* TodoController
* OData-OrderByValidator
* OData-MyEnableQuery
* Update controller
2019-04-24 07:23:28 -10:00
Tom Dykstra
c86e61d544
Clarify role of ApiController attribute ( #12023 )
2019-04-22 08:21:00 -07:00
Scott Addie
698660f904
Add animated gif demonstrating web API analyzer ( #12036 )
2019-04-18 12:49:07 -05:00
Taha Amin
197c652230
Update conventions.md ( #12027 )
...
using Microsoft.AspNetCore.Http.StatusCodes instead of numbers is much readable
2019-04-17 17:19:01 -05:00
Tom Dykstra
7811de8f00
JsonPatch ( #11648 )
2019-04-03 19:18:09 -07:00
Tom Dykstra
ba81a2cd1e
2.2 update ( #11737 )
2019-03-29 10:16:19 -07:00
James Newton-King
1e5e44ec3f
Update aspnetcore/web-api/define-controller/samples/WebApiSample.Api.21/Controllers/MyBaseController.cs
...
Co-Authored-By: Rick-Anderson <riande@microsoft.com>
2019-03-27 08:49:17 -10:00
Rick Anderson
4756e97d08
Update MyBaseController.cs
2019-03-27 08:26:53 -10:00
Nick Schonning
b2e21fe636
fix: Replace <code>, <em>, and <strong> tags ( #11597 )
2019-03-20 10:36:19 -05:00
Nick Schonning
33aac670ec
fix: MD022/blanks-around-headings/blanks-around-headers ( #11603 )
2019-03-19 15:18:13 -05:00
Nick Schonning
188fdb2abe
fix: MD012/no-multiple-blanks ( #11596 )
...
Multiple consecutive blank lines
2019-03-19 13:56:32 -05:00
Jim Stott
ed50d9a138
Add missing scoped repo's and dbContext to startup.cs ( #11425 )
2019-03-18 09:39:26 -05:00
Scott Addie
107a15841e
Remove string of asterisks
2019-03-18 09:31:20 -05:00
Tom Dykstra
b96456c8b5
Add link ( #11434 )
2019-03-15 16:15:31 -05:00
August Shultz
270b4925fc
Update to fix Incorrect Markdown Syntax ( #11311 )
...
This is a simple fix to the markdown formatting.
2019-03-07 08:22:56 -10:00
Bart Lannoeye
b10558c28d
Use StatusCode instead of hardcoded integers ( #10886 )
...
* Added missing ProducesResponseType, aligned response types
Fixes #10613
* Apply suggestions from code review
Co-Authored-By: bartlannoeye <bart.lannoeye@gmail.com>
* Use StatusCodes instead of int for define-controller samples
* Use StatusCodes instead of int for action-return-samples
* Apply PR remarks
2019-02-19 12:43:18 -06:00
Bart Lannoeye
8b7c2203a0
Added missing ProducesResponseType, aligned response types ( #10885 )
...
* Added missing ProducesResponseType, aligned response types
Fixes #10613
* Apply suggestions from code review
Co-Authored-By: bartlannoeye <bart.lannoeye@gmail.com>
2019-02-19 10:22:45 -06:00
Carl-Hugo Marcotte
32f7044ab4
Update conventions.md ( #10666 )
2019-01-28 15:37:45 -06:00
Rick Anderson
92565aa6c9
Update index.md ( #10388 )
...
Fixes https://github.com/aspnet/Docs/issues/9051
2019-01-14 16:36:57 -10:00
Pranav K
ed6d2f3710
FromQuery ( #10348 )
...
* FromQuery
* Minor edits
* Fix build warning (#10350 )
2019-01-11 18:31:11 -06:00
Rick Anderson
4072576c0b
Update conventions.md ( #10349 )
...
Fixes #10072
2019-01-11 14:23:04 -10:00
Rick Anderson
36f6c17d4f
Controller action return types fix ( #10194 )
...
* Controller action return types fix
* work
* work
* Controller action return types PR patch (#10209 )
Addresses https://github.com/aspnet/Docs/pull/10194
2019-01-04 14:35:08 -10:00
Rick Anderson
566cd32833
Update custom-formatters.md ( #10104 )
...
Fixes #10103
2018-12-28 16:22:09 -10:00
Scott Addie
be167ff91f
API conventions cleanup for 2.2 ( #9761 )
...
* API conventions cleanup for 2.2
* Edits on analyzers doc
* React to feedback
* React to more feedback
2018-12-14 14:13:07 -06:00
Luke Latham
d18fa2b084
2.2 Sample Updates ( #9795 )
2018-12-04 10:56:13 -06:00
Scott Addie
cf986c7a68
Fix punctuation
2018-11-29 10:26:03 -06:00
Rick Anderson
73fda161c8
Update index.md ( #9581 )
...
Give it more SEO juice for those searching.
2018-11-14 09:53:48 -06:00
Pranav K
78b9850bf1
Add docs for api conventions and analyzers ( #9453 )
...
* Add docs for api conventions and analyzers
Fixes #8332
* Edit pass on API conventions and analyzers content (#9574 )
* Edit pass on 2.2 API docs (#9578 )
* Scottaddie/open api patch (#9582 )
* Edit pass on 2.2 API docs
* Resolve build warning
* Fix list formatting
2018-11-13 21:39:41 -06:00
Scott Addie
01cbe3293e
Explain relationship between model validation and [ApiController] ( #9377 )
...
* Explain relationship between model validation and [ApiController]
* React to feedback in index.md
* React to more feedback
2018-11-06 11:52:38 -06:00
Scott Addie
eb12cef59e
Delete Web API index page and redirect ( #9459 )
2018-11-05 16:58:35 -06:00
Tom Dykstra
c79fece1de
Add notes about availability of input formatter sample code ( #9403 )
...
Fixes #9394
2018-11-05 10:10:35 -08:00
Rick Anderson
0ee6b101d9
delete map and min files ( #9310 )
2018-10-31 14:26:48 -10:00
Scott Addie
55f0638c56
2.2 updates to web API doc ( #9303 )
...
Fixes https://github.com/aspnet/Docs/issues/9298
**Summary of Changes**
* Display the "Problem details" section for 2.2+ only
* Restore the missing `Startup.ConfigureServices` code snippets
* Genericize the compat flag language
* Use the `ConfigureApiBehaviorOptions` method for the 2.2 doc
* Add content for `[assembly: ApiController]` in the 2.2 doc
* Expand upon default response type returned for 400 status codes
* Added a solution file for the sample app to improve usability
* A quick UE pass
**Internal Review Pages**
* [2.2](https://review.docs.microsoft.com/en-us/aspnet/core/web-api/?branch=pr-en-us-9303&view=aspnetcore-2.2#problem-details-responses-for-error-status-codes )
* [2.1](https://review.docs.microsoft.com/en-us/aspnet/core/web-api/?branch=pr-en-us-9303&view=aspnetcore-2.1#problem-details-responses-for-error-status-codes )
* [2.0](https://review.docs.microsoft.com/en-us/aspnet/core/web-api/?branch=pr-en-us-9303&view=aspnetcore-2.0#problem-details-responses-for-error-status-codes )
2018-10-30 13:01:52 -05:00
Scott Addie
1d8c0fb4a6
Fix snippet type
2018-10-29 12:26:28 -05:00
Alfred Myers
2083734da1
Fixed typo on web-api/index.md ( #9293 )
2018-10-29 11:00:23 -05:00
Tom Dykstra
b6ba3d220c
Table of Contents reorg ( #9133 )
...
* overview
* whats new to end
* fix migration node
* split fundamentals, move to end
* glob & loc, get started
* security node name
* security section
* azure, client-side, host
* several more sections
* redistribute tutorials
* proofread fixes
* move how to download section
* index files delete and redirect
* fix errors
* reorder some nodes
* scott feedback, flatten main tutorials node
* fix missed feedback items + other issues
* unflatten tutorials node
* move 'how to download'
* more tutorials node tweaks
* standardize view sample links
* db --> DB
* fix build error
* remove link from a parent node
* streamline node names
* xref links
* typos
* typo
* typos and revert some xref links
* scott feedback
* scott feedback
* feedback
* change node name
* safe storage-->protect
2018-10-26 18:34:40 -10:00
Luke Latham
5704de168e
Implicit versioning of the All package ( #9223 )
...
Fixes #9219
@JunTaoLuo Dan calls out the implicit versioning "for 2.1 SDK or later;" however, we don't usually version the doc content by SDK release. We might need to say something for this update in the passage that I'm adding to the All topic (*aspnetcore/fundamentals/metapackage.md*) about which SDK version this applies to. I don't know if that's something that you would like to do or what version to call out.
I also remove the version from the samples. We also assume that devs are using the latest SDK with our samples.
2018-10-25 15:16:50 -10:00
Pranav K
9c91d557c9
Add docs for ProblemDetails response filter ( #9130 )
...
* Add docs for ProblemDetails response filter
* UE edits to problem details (#9152 )
[review URL](https://review.docs.microsoft.com/en-us/aspnet/core/web-api/index?view=aspnetcore-2.2&branch=pr-en-us-9152 )
2018-10-24 13:17:57 -10:00
Luke Latham
8e6dd4a7f4
Drop version from App package ( #8881 )
...
Addresses #8579
I might be getting the hang of **_find and replace_** now. 😝
This doesn't touch a couple that ref 2.2.0. I'll tidy those up on https://github.com/aspnet/Docs/issues/8518 after 2.2 RTM.
2018-10-06 17:10:28 -10:00
Luke Latham
46f41d4774
Update All and App package versions ( #8513 )
2018-09-13 11:39:23 -05:00
Luke Latham
1a0f79a8fe
Update All/App package version ( #8489 )
2018-09-11 08:53:03 -05:00
Scott Addie
329eabef95
Dedent code snippet to fix display ( #8455 )
...
Fixes https://github.com/aspnet/Docs/issues/8454
2018-09-07 15:44:03 -05:00
Luke Latham
2c7f11f3af
Move SetCompatibilityVersion into an MVC subtopic ( #8196 )
...
Escape an underscore
Escape more underscores
And another one
2018-08-21 12:57:06 -07:00
Scott Addie
8ed9bb212b
Support .NET API xref links in ASP.NET Core docs ( #8112 )
...
Fixes https://github.com/aspnet/Docs/issues/7064
Modified 1 doc to demonstrate the new syntax. See http://dotnet.github.io/docfx/tutorial/links_and_cross_references.html#cross-reference-services for more context around the *docfx.json* file change.
[Internal Review Page](https://review.docs.microsoft.com/en-us/aspnet/core/web-api/?branch=pr-en-us-8112&view=aspnetcore-2.1#additional-resources )
/cc: @mairaw I took a different approach than how it's done in the dotnet/docs repo. Copying you in case you're interested in this solution.
2018-08-16 15:04:03 -05:00
Alex Dresko
7e0fd8020e
Update index.md ( #8067 )
...
Fixes https://github.com/aspnet/Docs/issues/8057
2018-08-14 10:39:25 -05:00
Scott Addie
4b4b8e5f2a
Replace line numbers range with snippet name
2018-07-24 21:44:05 -05:00
Scott Addie
b85b92fd84
Expand explanation of [ProducesResponseType] attribute simplification ( #7781 )
...
Fixes https://github.com/aspnet/Docs/issues/7723
2018-07-24 08:34:38 -05:00
Scott Addie
0ed1ad80f6
Add warning about interfaces and implicit cast operators
2018-07-23 21:48:35 -05:00
Luke Latham
34b33e245b
Add version to App package references ( #7551 )
...
Fixes #7532
2018-07-10 22:43:09 -05:00
Scott Addie
6bfabdb9c8
Convert synchronous web API methods to async ( #7544 )
...
* Convert synchronous web API methods to async
* React to feedback
2018-07-10 14:08:50 -05:00
Luke Latham
2059dd8b41
Add CRLF to the last line of MD topics ( #7509 )
2018-07-08 21:48:10 -05:00
Scott Addie
c3df45e474
Remove locale from URLs
2018-07-06 21:30:47 -05:00
Scott Addie
4f450caa71
Web API sample app cleanup ( #7506 )
...
- Removes an unnecessary *global.json* file
- Removes an unnecessary NuGet package
- Fixes 2 broken links in README file
2018-07-06 21:28:09 -05:00
Scott Addie
cafbadf89f
Clarify when to suppress default [ApiController] behaviors in Startup ( #7501 )
...
Fixes https://github.com/aspnet/Docs/issues/6881
2018-07-06 15:46:10 -05:00
Scott Addie
e23bf6825e
Mention 2.1 compat flag requirement for [ApiController] ( #7491 )
...
Fixes https://github.com/aspnet/Docs/issues/7407
[Internal Review Page](https://review.docs.microsoft.com/en-us/aspnet/core/web-api/?view=aspnetcore-2.1&branch=pr-en-us-7491#annotate-class-with-apicontrollerattribute )
2018-07-06 12:54:41 -05:00
Scott Addie
4bad6f3978
Update web API sample apps to 2.1 RTM implicit packageref ( #7245 )
...
Addresses https://github.com/aspnet/Docs/issues/7239
2018-06-22 12:52:25 -05:00
Scott Addie
f8668437fe
Metadata updates for web API conceptual content
2018-06-18 13:37:17 -05:00
Scott Addie
52c49c924d
Update sample apps to 2.1 RTM ( #6752 )
...
Addresses https://github.com/aspnet/Docs/issues/5495
Updates 2 web API samples and a Partial Tag Helper sample from 2.1 RC1 to 2.1 RTM.
2018-05-31 13:24:21 -05:00
Luke Latham
d95fa4b7e4
Repair broken link ( #6512 )
2018-05-21 07:49:21 -05:00
Luke Latham
57e676a702
Remove Samples (uppercase) folder ( #6479 )
2018-05-18 10:35:48 -05:00
Luke Latham
876849285c
Change sample folder casing ( #6475 )
2018-05-18 10:06:43 -05:00
Rick Anderson
059bbc60f7
replace tdykstra with rick-anderson ( #6395 )
2018-05-12 13:55:26 -10:00
Rick Anderson
7a2b517b72
Update preview to RC1 ( #6375 )
...
* remove preview
* rc
2018-05-11 14:03:53 -10:00
Scott Addie
d05ede2aef
Fix incorrect method name reference ( #6317 )
2018-05-09 14:51:05 -05:00
Scott Addie
5331a0b962
Add link to ActionResult<T> API ref ( #6315 )
2018-05-09 14:01:57 -05:00
Scott Addie
5bc8ba8b55
Link to ApiControllerAttribute API ref ( #6313 )
2018-05-09 13:42:41 -05:00
Luke Latham
7048bb8fbf
API link updates ( #6149 )
...
* API link updates
Updates
One more!
Fix bookmark
Mo updates
More updates
Updates
Updates
* Update action-return-types.md
* Update index.md
* Update concurrency.md
* Update intro.md
* Update localization.md
* Update search.md
2018-05-02 14:45:06 -05:00
Rick Anderson
00abcf3cbb
Update index.md ( #6171 )
2018-05-01 18:15:16 -10:00
Rick Anderson
8b62e71f85
Document that [FromRoute] does not unescape %2F ( #6167 )
...
* Update index.md
* Minor tweaks
2018-05-01 17:41:08 -10:00
Scott Addie
976dbaf7b6
Fix broken sample app links ( #6085 )
...
* Fix broken sample app links
* Use consistent formatting for sample links text
2018-04-25 13:36:10 -05:00
Scott Addie
d7716559e8
Add Web API controller definition doc ( #6003 )
...
* Add Web API controller definition doc
* Remove wwwroot folder reference from csproj file
* Verbiage tweaks
* Add info about FromForm inference
* Bold the attribute names
* Add TOC entries
* Change link ordering in TOC
* Add note about IntelliSense
* Major sample app changes
* Fix code snippet line numbers
* Minor verbiage tweaks
* Add a README file
* Add TestController.cs
* Verbiage changes
* Shorten wording
* Change wording
* Minor edit
* React to feedback
* Add attributes table
* Verbiage tweaks
* querystring -> query string
* Minor edit
* Add 2.1 controller samples
* Fix invalid moniker names
* Update code sample to 2.1
* Update line number
* Convert uppercase W to lowercase
* React to feedback
* Update sample app's README file
* Project file cleanup
* Replace word
* Remove MVC views from sample app
* Derive from ControllerBase instead of Controller
2018-04-24 14:03:55 -05:00
Scott Addie
d861cebef1
Fix unordered list formatting with monikers
2018-04-13 10:02:56 -05:00
Scott Addie
1f6ef5f4bd
Add zone versioning to action return types doc
2018-04-10 13:54:55 -05:00
Rick Anderson
1832723bd1
CI Update ( #5878 )
2018-04-04 13:51:35 -10:00
Scott Addie
b2cdf7ff05
Relocate advanced MVC docs to Web API TOC ( #5859 )
2018-04-02 15:22:30 -04:00
Scott Addie
88bf955905
Add Web API controller action return types doc ( #5750 )
...
* Add Web API controller action return types doc
* Verbiage tweaks
* Verbiage clarification
* Rename action and add a tip widget
* Tweak verbiage in tip widget
* Add another tip widget
* More verbiage changes
* MOAR tweaks!
* Expand description in specific type section
* Fix invalid OkObjectResult syntax
* Address Acrolinx feedback
* Add Web API TOC node and README.md file to samples folder
* React to feedback
2018-03-21 21:41:16 -05:00