Update rest_extract to use OAS3

Author: mhruska

rest_extract/apply_templates.py

@@ -27,7 +27,7 @@ def apply_template(spec_file, template, model):
 
     elif model == 'fa2':
 
-        spec_yaml['securityDefinitions'] = template_yaml['securityDefinitions']
+        spec_yaml['components']['securitySchemes'] = template_yaml['components']['securitySchemes']
         spec_yaml['security'] = template_yaml['security']
         spec_yaml['tags'] = template_yaml['tags'] + spec_yaml['tags']
         for p in template_yaml['paths']:
@@ -37,26 +37,14 @@ def apply_template(spec_file, template, model):
         #nothing specific, already set Info above.
         pass
 
-    # delete the example offset of 10
-    # todo: Open Jira for this one to fix in upstream template
-    try:
-        del spec_yaml['parameters']['Offset']['x-example']
-    except KeyError:
-        pass
-
-    # some templates have host set to [array]
-    if 'host' in spec_yaml:
-        del spec_yaml['host']
-
-    # some templates list http & https some list https
-    # we want just http, which it will use by default when not there
-    if 'schemes' in spec_yaml:
-        del spec_yaml['schemes']
+    # some templates have servers set to "https://[array]/" and "http://[array]/"
+    # we want just http, which it will use by default when not there, and we don't want the [array]
+    if 'servers' in spec_yaml:
+        del spec_yaml['servers']
 
     # Sort spec_yaml dict so the output text puts consistent information at the top
     sort_order = [
-        'swagger', 'info', 'host', 'basePath', 'schemes', 'securityDefinitions', 'security',
-        'consumes', 'produces', 'paths', 'definitions', 'parameters', 'responses', 'tags', 'externalDocs'
+        'openapi', 'info', 'servers', 'security', 'paths', 'components', 'tags'
     ]
 
     sorted_spec_yaml = {key: spec_yaml[key] for key in sort_order if key in spec_yaml}
@@ -83,7 +71,7 @@ def main():
 
 
     spec_directory = os.path.join(project_dir, "html", "specs")
-    original_spec_directory = os.path.join(project_dir, "definitions", "oas2.0")
+    original_spec_directory = os.path.join(project_dir, "definitions", "oas3.x")
 
     with open(os.path.join(script_path, "fb_template.yaml"), encoding='utf-8') as f:
         fb_template_yaml = yaml.safe_load(f)

rest_extract/fa2_template.yaml

@@ -1,5 +1,5 @@
 ---
-swagger: "2.0"
+openapi: "3.0.1"
 info:
   title: Pure FlashArray API 2.0
   version: "1.0"
@@ -19,16 +19,6 @@ info:
     ### 
 
     Intro to how OAuth2 works with the 2.0 version: [Intro](https://support.purestorage.com/FlashArray/PurityFA/Purity_FA_REST_API/Reference/REST_API_2.0_Authentication_Guide)
-    
-securityDefinitions:
-  OAuth2-Bearer-Token:
-    type: apiKey
-    in: header
-    name: Authorization
-  X-Auth-Token:
-    type: apiKey
-    in: header
-    name: x-auth-token
 
 security:
 - OAuth2-Bearer-Token: []
@@ -57,24 +47,22 @@ paths:
             
             openssl rsa -in private.pem -outform PEM -pubout -out public.pem
       responses:
-        200:
-          description: "Token Generated"
-          schema:
-            type: object
-            properties:
-              private_key:
-                type: string
-                description: Private key in PEM format.
-              public_key:
-                  type: string
-                  description: Public key in PEM format.
+        "200":
+          description: Token Generated
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  private_key:
+                    type: string
+                    description: Private key in PEM format.
+                  public_key:
+                    type: string
+                    description: Public key in PEM format.
       tags: [Auth Helpers]
   /oauth2_token_from_private_key:
     post:
-      consumes: 
-        - "text/plain"
-      produces:
-        - "application/json"
       description: |-
         Authenticates to Flasharray, This returns a token_id (think session id), from an existing API Client, 
         This is not part of the FlashArray API, it's a helper endpoint making it easy to generate an 
@@ -83,52 +71,68 @@ paths:
         of what is happening.
 
         Copy the output value, Authorization header, and then click on the green Authorize button at the 
-        top of the page.  Paste in the value into 
+        top of the page.  Paste in the value into
       responses:
-        200:
-          description: "Token Generated"
-          schema:
-            type: object
-            properties:
-              Authorization:
-                type: string
-                description: An OAuth bearer token to be used in the Authorization header for authorization to API endpoints.
-              description:
-                type: string
-                desciption: How to use token
-
-            example: {"username":"pureuser"}
+        "200":
+          description: Token Generated
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  Authorization:
+                    type: string
+                    description: An OAuth bearer token to be used in the Authorization header for authorization to API endpoints.
+                  description:
+                    type: string
+                    description: How to use token
+                example: {"username":"pureuser"}
+      x-codegen-request-body-name: private_key
       tags: [Auth Helpers]
       parameters:
         - name: issuer_name
           in: header
-          type: string
+          schema:
+            type: string
           description:  Issuer value displayed in the FlashArray API
                         Registration page or pureapiclient list ) by default it's the same name as API Client
 
         - name: client_id
           in: header
-          type: string
+          schema:
+            type: string
           description:  Client Id value displayed in the FlashArray API
                         Registration page or pureapiclient list
 
         - name: key_id
           in: header
-          type: string
+          schema:
+            type: string
           description:  Key Id value displayed in the FlashArray API
                         Registration page or pureapiclient list
 
         - name: username
           in: header
-          type: string
-          description:  The name of a valid user on the FlashArray that will be authenticated to.
-    
-        - name: private_key
-          required: true
-          in: body
-          schema: 
+          schema:
             type: string
-          description: Private key in PEM format that was used to create the Public key for this API Client specified as the issuer in this call.
+          description:  The name of a valid user on the FlashArray that will be authenticated to.
+      requestBody:
+        description: Private key in PEM format that was used to create the Public key for this API Client specified as the issuer in this call.
+        content:
+          text/plain:
+            schema:
+              type: string
+        required: true
+components:
+  securitySchemes:
+    OAuth2-Bearer-Token:
+      type: apiKey
+      name: Authorization
+      in: header
+    X-Auth-Token:
+      type: apiKey
+      name: x-auth-token
+      in: header
 
 
 tags: