Commit Graph

23 Commits (69e2acf135430ee588f524a08189f40d4c2d1e52)

Author SHA1 Message Date
Scott Addie 9d317b9e31
Link to C# default NoWarn values (#10828) 2019-02-06 15:59:17 -06:00
Scott Addie 0269167e24
Add blurb about web API conventions in Swashbuckle doc (#10057)
* Add blurb about web API conventions in Swashbuckle doc

* Update NSwag doc too

* Update aspnetcore/tutorials/getting-started-with-NSwag.md

Co-Authored-By: scottaddie <10702007+scottaddie@users.noreply.github.com>

* Update aspnetcore/tutorials/getting-started-with-swashbuckle.md

Co-Authored-By: scottaddie <10702007+scottaddie@users.noreply.github.com>
2018-12-18 16:38:49 -06:00
Luke Latham e2838d2d8f
Drop 'reverse proxy' language (#9746) 2018-12-03 16:52:20 -06:00
Robb Schiefer 0d1834264f Added note for working with virtual directories (#9128)
I spent a day or more researching this so that I could use Swagger-UI in my ASP.NET Core API which is used with a reverse-proxy and virtual directory.  In the end found Swagger-UI requires relative URLs to start with a period.  Related to https://github.com/swagger-api/swagger-ui/issues/4107

Hoping this documentation note will help others.

When creating a new PR, please do the following and delete this template text:

* Reference the issue number if there is one:

  Fixes #Issue_Number

  > The "Fixes #nnn" syntax in the PR description causes
  > GitHub to automatically close the issue when this PR is merged.
2018-11-14 10:11:23 -06:00
Luke Latham af27696750 Update 'Static Files Middleware' (#9421)
Fixes #9420

The correct name includes "File" (singular).

Ref: https://docs.microsoft.com/dotnet/api/microsoft.aspnetcore.staticfiles.staticfilemiddleware
2018-11-10 09:13:27 -10:00
Luke Latham 659e3ce17f Update BuildWebHost to CreateWebHostBuilder (MD topics) (#9268)
* Update BuildWebHost to CreateWebHostBuilder (MD topics)

Updates

Updates

Update

Tab update

Repair versioning

* Revert Swashbuckle changes

* Dropping versions <2.1 in two topics

* Versioning update

Versioning update

* Resolve tab warning
2018-11-05 13:10:38 -10: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
Scott Addie acdee00f33
Treat middleware name as proper noun (#8172)
Related to https://github.com/aspnet/Docs/pull/8171
2018-08-20 11:06:25 -05:00
Scott Addie 8e7a46ff2b
Add instruction to install static files package (#8171)
Fixes https://github.com/aspnet/Docs/issues/8099
2018-08-20 10:55:19 -05:00
Matt Millican 0364c7eea6 Add recommendation and example for ignoring XML doc warnings per class (#7849)
Fixes #7795 - Add recommendation for ignoring XML doc warnings for certain classes in Swagger documentation

[Internal Review Page](https://review.docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.1&branch=pr-en-us-7849&tabs=visual-studio%2Cvisual-studio-xml#xml-comments)
2018-07-30 11:19:42 -05:00
Scott Addie 788f3eb9a5
[WIP] Updates to web API help pages tutorial for XML doc gen (#7385)
Updates to web API help pages tutorial for XML doc gen
2018-06-29 15:20:48 -05:00
Scott Addie fd13c68dd8
Metadata updates to ASP.NET Core tutorials (#7193)
Addresses #6541
2018-06-20 14:25:03 -05:00
Scott Addie 06d5f6cfb5
Fix Swashbuckle tutorial for 1.x apps (#6761)
Addresses https://github.com/aspnet/Docs/issues/6686 (still need to address deployment concerns)
Addresses https://github.com/aspnet/Docs/issues/5495

**Changes**
- Update 2.1 sample app from RC1 to RTM
- Simplify sample app download link markup

[Internal Review Page](https://review.docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-1.1&branch=pr-en-us-6761#add-and-configure-swagger-middleware)
2018-05-31 20:32:30 -05:00
Luke Latham 49e38929e5
Revert tab controls (#6350) 2018-05-10 19:58:40 -05:00
Scott Addie 31be69874d Add sample app download links to help page tutorials (#6319) 2018-05-09 11:25:09 -10:00
Scott Addie 99b4ad3d1c
Update Swagger tutorials for 2.1 (#6193)
* Update Swagger tutorials for 2.1

* Improve PMC instructions

* Verbiage tweaks

* Fix code highlighting in NSwag tutorial

* Remove unnecessary screenshots

* Apply 2.1 moniker to Swashbuckle tutorial

* Replace line numbers with region name

* NSwag 2.1 sample app updates

* Update Data annotations section of NSwag doc

* Add tip to NSwag doc

* Minor tweaks

* NSwag doc updates

* Fix API ref links

* Add section for adding API info

* Add sentence to Customize section

* Convert H2 heading to H3

* React to feedback
2018-05-09 14:54:24 -05:00
Rick Anderson 1832723bd1
CI Update (#5878) 2018-04-04 13:51:35 -10:00
Scott Addie f8571ffada
Update Web API tutorial's Swashbuckle dependency to 2.x (#5803)
* Update tutorial to Swashbuckle 2.x

* Update the Customize the UI instructions

* React to Acrolinx feedback
2018-03-26 15:50:15 -05:00
Luke Latham f7e92a3e67 Title, description, and H1 updates (3) (#5717) 2018-03-19 13:40:34 -10:00
Scott Addie 25c5672bf1
Fix metadata in Web API help pages docs (#5706) 2018-03-15 13:31:33 -05:00
Scott Addie a8e45c9d59
Restore instructions for suppressing XML comment warnings (#5662) 2018-03-12 13:50:51 -05:00
Scott Addie 4821ff6a2c
Wire up new Swagger docs to TOC (#5644) 2018-03-09 17:28:07 -06:00
Rico Suter b57b0cb67d [WIP] Changed Web Api Help Pages using Swagger, added sub pages for NSwag & Swashbuckle (#5622)
Changed Web Api Help Pages using Swagger, added sub pages for NSwag & Swashbuckle
2018-03-09 17:12:20 -06:00