Граф коммитов

382 Коммитов

Автор SHA1 Сообщение Дата
Doug Erickson [MSFT] 8721eeff3a Update swagger-authoring-descriptions.md 2016-10-24 13:42:14 -07:00
Doug Erickson [MSFT] 6148ff942c Update swagger-authoring-descriptions.md 2016-10-24 13:40:20 -07:00
Doug Erickson [MSFT] e1b8a43c44 Update swagger-authoring-descriptions.md 2016-10-24 13:39:37 -07:00
Tamra Myers aab9ee83e7 Update swagger-authoring-descriptions.md
Looks great! Hope you'll forgive the copy-editing suggestions.

#7 in the list could be "Include links to other content when necessary," and point to how/where to find those. I don't know whether these descriptions support links, so I'll leave that to you to include if it's worthwhile. 

You might also note that it's helpful to indicate in the description for a request header/query parameter whether it is required or optional.

I'm not sure what "the Linter" is, although I heard you say it the other day, so that might be good to define here.
2016-10-21 17:52:26 -07:00
Doug Erickson 6b80785f7c fixed file name and cleaned up some formatting issues. 2016-10-21 17:12:07 -07:00
Doug Erickson 91069a2b68 first draft of description authoring doc 2016-10-21 17:01:09 -07:00
Thomas Bombach 3a6c0131bc Adding a bootstrap Swagger example file
- Fixing broken documentation links
2016-10-11 09:39:52 -07:00
Thomas Bombach fe0781bff8 Removing documentation checklist and replacing it with PULL_REQUEST_TEMPLATE.md
First pass at pull request template

Adding contribution documentation in CONTRIBUTING.md

Adding pattern in documentation for links back to the adx-documentation-pr repo
2016-09-23 15:04:16 -07:00
Amar Zavery 4df27128e5 Update swagger-good-patterns.md 2016-09-10 09:48:09 -07:00
Amar Zavery b1d27c9e40 Update swagger-good-patterns.md 2016-09-10 09:45:47 -07:00
Amar Zavery c32f172ed1 Update swagger-good-patterns.md 2016-09-08 18:42:27 -07:00
Amar Zavery be90f31d83 Merge pull request #524 from anudeepsharma/Guidelines
Added few more guidelines for good pattern for swagger.
2016-09-08 18:23:09 -07:00
Anudeep Sharma b7869a6ba8 Added few more guidelines for good pattern for swagger. 2016-09-08 17:31:49 -07:00
Amar Zavery 1f78d81358 Merge pull request #518 from Azure/json-code-block
Updating "Creating Swagger" doc code blocks
2016-09-07 20:35:45 -07:00
Scott Phibbs 823f3ffac7 Create swagger-pr-checklist 2016-09-07 10:16:29 -07:00
Thomas Bombach 281816c2f5 Updating Creating Swagger doc code blocks
Since JSON is very strict about comments and non-JSON characters, Github does some ugly highlighting when using `...` to represent omitted lines in our documentation. By switching to the `json5` hint for large code blocks, it's a little easier to read.

This is only a documentation formatting change. It has no impact on the specs in this repo.
2016-09-02 16:25:59 -07:00
Kirthi Krishnamraju f6ce817bd8 Added documentation for linter here 2016-08-24 21:04:51 -07:00
Amar Zavery ed166de6be doc update 2016-08-21 11:37:25 -07:00
Kirthi Krishnamraju dae3e70af6 Added swagger extensions and good patterns document (#485) 2016-08-19 15:58:32 -07:00
Amar Zavery b0d83f3ccf Update creating-swagger.md 2016-02-11 14:10:15 -08:00
Amar Zavery b0ccc81946 Updated Swagger Spec Url 2016-02-11 14:08:24 -08:00
stankovski f07fdb8674 Updated documentation 2015-12-23 11:14:04 -08:00
Amar Zavery b449a7cb1d Update creating-swagger.md 2015-12-14 18:35:04 -08:00
Amar Zavery bc7fb42cb8 Update creating-swagger.md 2015-12-14 11:54:04 -08:00
Amar Zavery 5c6bf3b960 refined the explanation for negative response code behavior 2015-12-14 11:52:51 -08:00
Amar Zavery a2a1310601 Updated explanation for negative response codes. 2015-12-14 11:47:26 -08:00
Amar Zavery 746819badd removed extra paranthesis 2015-12-11 19:16:33 -08:00
Amar Zavery e104ed2033 long running 2015-12-11 17:00:21 -08:00
Amar Zavery ddabd39b67 added index to the documentation 2015-12-11 16:33:12 -08:00
Amar Zavery 18f2597b8d minor tweaks 2015-12-11 15:49:29 -08:00
Amar Zavery e3a1295e3f some doc fixes 2015-12-11 15:45:11 -08:00
Amar Zavery 66f0fc7f43 Documentation for creating swagger 2015-12-11 15:10:20 -08:00