Merge pull request #144 from microsoft/spark0698/update-links-docs

Update README and Swagger docs

README.md

@@ -6,7 +6,7 @@ The Microsoft [Security Update Guide](https://msrc.microsoft.com/update-guide) i
 This repository contains sample code and documentation for the Microsoft Security Updates API (https://portal.msrc.microsoft.com/en-us/developer), including:
 * source code for the [MsrcSecurityUpdates PowerShell module](https://www.powershellgallery.com/packages/MsrcSecurityUpdates)
 * sample code for using the [MsrcSecurityUpdates PowerShell module](https://www.powershellgallery.com/packages/MsrcSecurityUpdates)
-* OpenAPI/Swagger definition for the Microsoft Security Updates API
+* [OpenAPI/Swagger definition](docs) for the Microsoft Security Updates CVRF API
 
 # Getting the MsrcSecurityUpdates PowerShell Module
 Getting started with the MsrcSecurityUpdates module can be done like this:
@@ -29,8 +29,6 @@ Once the module is loaded, check out our [PowerShell samples](https://github.com
 Customers should treat this repository as custom code.  Bug fixes or enhancements can be requested by opening a new issue from the Issues tab.
 ## Security Update Support
 For questions about CVEs, security updates and patches, please visit [Microsoft Support](https://support.microsoft.com)
-## Security Update Guide Support
-For questions about the [Microsoft Security Update Guide](https://msrc.microsoft.com/update-guide) please visit the [Security Update Guide support forum](https://social.technet.microsoft.com/Forums/security/en-us/home?forum=securityupdateguide).
 
 # Contributing
 

docs/README.md

@@ -1,6 +1,10 @@
 # Documentation
 
-The documentation (in the form of swagger documentation) can be used to help developers who wish to implement their own API requests / response handling to get the correct responses and fields. For more information check out http://swagger.io It is a great project and has great staff working on it. To view the API, you can open the [swagger-ui demo](http://petstore.swagger.io/) and put the link to the raw swagger.json in the top bar then click explore. swagger-ui can be downloaded locally and ran if you need to integrate this into how you interact with the api.
+Documentation for the Microsoft Security Updates CVRF API can be found in the form of Swagger documentation.
+
+The documentation can be used to help developers who wish to implement their own API requests / response handling to get the correct responses and fields. For more information check out http://swagger.io. It is a great project and has great staff working on it. 
+
+To view the API, you can open the [swagger-ui demo](http://petstore.swagger.io/) and put the link to the raw [swagger.json](swagger.json?raw=1) in the top bar then click explore. Swagger-ui can be downloaded locally and run if you need to integrate this into how you interact with the api.
 
 As a note about the swagger, there are two response models defined for the CVRF endpoint. one for json and the other for xml. This is because swagger does not currently have a way to return two different schemas for XML and JSON responses. If you are looking at the swagger definitions and want the correct XML response, please change the response ref accordingly. To find the location to change, search the swagger.json or swagger.yaml for the text: `#/definitions/cvrfReturnTypes200` then simply add \_xml to the end (so it reads `#/definitions/cvrfReturnTypes200_xml`).
 
@@ -9,6 +13,3 @@ For more information on CVRF, please view the following links:
 https://cve.mitre.org/cve/cvrf.html
 
 http://www.icasi.org/the-common-vulnerability-reporting-framework-cvrf-v1-1/
-
-**Note: there is [currently a bug](https://github.com/swagger-api/swagger-editor/issues/1303
-) in the new swagger editor (http://editor.swagger.io). If you see the error "Semantic error at paths./Updates('{id}') Partial path templating is not allowed.", don't be alarmed. the older swagger editor (http://editor2.swagger.io) will render the swagger without errors. There shouldn't be any issue with how the new editor displays the endpoint or its responses, it just puts an error at the top of the page**