Merge pull request #2 from SmartBear-DevRel/docs/scen

docs: add scenario outlines and pointers to branches/slides/vidoes

README.md

@@ -6,6 +6,8 @@ A sample solution taking an API definition from SwaggerHub, crafting a Lambda fu
 ## Table of Contents
 - [Problem Statement](#problem-statement)
 - [Solution Overview](#solution-overview)
+   - [Scenarios](#scenarios)
+    - [Scenario Links](#scenario-links)
    - [High level steps](#high-level-steps)
 - [Prerequisites](#prerequisites)
 - [Instructions](#instructions)
@@ -37,7 +39,36 @@ By leveraging the seamless integration between SwaggerHub’s API design and doc
 ## Solution Overview
 In this integrated exercise you will create an end-to-end solution which takes you through the process of creating an OpenAPI Specification (OAS) design definition, and deploying the API to an operational AWS environment.
 
-#### High level steps
+### Scenarios
+
+The `main` branch of this repository contains a simple end-to-end solution.
+
+Alongside supporting webinars/workshops, additional scenarios are stored in separate branches.
+
+1. `vuln-api`
+   - This example the process of
+     - creating an OpenAPI Specification (OAS) design definition
+     - deploying the API to an operational AWS environment.
+     - exploring the deployed API to manually identify security vulnerabilities.
+2. `vuln-api-hardened`
+   - This example follows on the `vuln-api` branch and shows the process of
+     - using Spectral public and custom rule-sets to identify vulnerabilities early in the design and development process in
+       - SwaggerHub
+       - CI
+       - Locally
+     - rectifying the security vulnerabilities.
+     - deploying our updated API to an operational AWS environment.
+     - exploring the deployed API to ensure the security vulnerabilities have been resolve
+
+#### Scenario Links
+
+| Content                                                                              | Link                                                                                                                         | Branch Name                                                                                                    | Overview |
+| ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------- |
+| How to Streamline API Development on Amazon API Gateway Using SmartBear’s SwaggerHub | [Blog](https://aws.amazon.com/blogs/apn/how-to-streamline-api-development-on-amazon-api-gateway-using-smartbear-swaggerhub/) | [`main`](https://github.com/SmartBear-DevRel/SwaggerHub-AWSGateway-Lambda/tree/main)                           | simple e2e solution         |
+| Defend Your APIs - Secure by Design                                                  | [Watch](https://smartbear.com/resources/webinars/defend-your-apis-secure-by-design/?ws=2) / [Slides](https://assets.smartbear.com/transfer/11947ca5400879e80f0d0c90a8a4a94eef42244c4bf57de7b0edcf80e9322a35)                                                                                                                   | [`vuln-api`](https://github.com/SmartBear-DevRel/SwaggerHub-AWSGateway-Lambda/tree/vuln-api)                   | Vulnerable API e2e deployed and explored      |
+| Defend Your APIs - Secure by Design                                                  | [Watch](https://smartbear.com/resources/webinars/defend-your-apis-secure-by-design/?ws=2) / [Slides](https://assets.smartbear.com/transfer/11947ca5400879e80f0d0c90a8a4a94eef42244c4bf57de7b0edcf80e9322a35)                                                                                                                      | [`vuln-api-hardened`](https://github.com/SmartBear-DevRel/SwaggerHub-AWSGateway-Lambda/tree/vuln-api-hardened) | Vulnerable API issues identified and rectified               |
+
+### High level steps
 - Import an existing OAS `Books API` definition into SwaggerHub SaaS design & documentation tool
 - Enable and test API auto-mocking on the newly imported API in SwaggerHub
 - Build, test and deploy the following AWS resources/services:
@@ -169,4 +200,4 @@ One of the major benefits of a gateway function is being able to observe how an
 - Using the [SwaggerHub CLI](https://github.com/SmartBear/swaggerhub-cli) (Command Line Interface)
 - Adding [custom standardization](https://support.smartbear.com/swaggerhub/docs/organizations/api-standardization.html) rules and guidelines to SwaggerHub
 - Using [SwaggerHub domains](https://support.smartbear.com/swaggerhub/docs/domains/index.html) (shared code libraries) to share common API components across multiple APIs
-- Adding [authentication](https://swagger.io/docs/specification/authentication/) to the sample API and AWS Gateway
+- Adding [authentication](https://swagger.io/docs/specification/authentication/) to the sample API and AWS Gateway