Add operation-level security, refs #19

Mermade · Oct 20, 2017 · da76f49 · da76f49
1 parent 3df9d34
commit da76f49
Show file tree

Hide file tree

Showing 4 changed files with 89 additions and 2 deletions.
diff --git a/docs/TODO.md b/docs/TODO.md
@@ -8,6 +8,8 @@
 * ~~Finish parameter enums~~
 * Rework tags-input
 * ~~Editing of requestBody schemas / content-types~~
+* ~~Operation-level security~~
+* Scope editor for operation-level security
 * Editing of requestBody examples
 * Add validation on form fields
   * License name is required if license url is filled in (thus the object is present)

diff --git a/docs/openapi3-support.md b/docs/openapi3-support.md
@@ -31,7 +31,7 @@ This document outlines this project's support for visualising the [OpenAPI V3][o
 - [x] [servers](#servers-object)
 - [ ] [paths](#paths-object)
 - [ ] [components](#components-object)
-- [ ] [security](#security-requirement-object)
+- [x] [security](#security-requirement-object)
 - [ ] [tags](#tag-object)
 - [x] [externalDocs](#external-documentation-object)
 
@@ -77,7 +77,7 @@ This is supported by default as all `$ref` are dereferenced before the definitio
 - [ ] [examples](#example-object)
 - [x] [requestBodies](#request-body-object)
 - [x] [headers](#header-object)
-- [ ] [securitySchemes](#security-scheme-object)
+- [x] [securitySchemes](#security-scheme-object)
 - [ ] [links](#link-object)
 - [x] [callbacks](#callback-object)
 

diff --git a/src/method/method.html b/src/method/method.html
@@ -397,6 +397,27 @@
 
             </div>
 
+            <div class="method-pane method-pane-security hidden container is-fluid">
+                <div class="level">
+                    <label class="label" for="chkDefault">Use default security</label>
+                    <input id="chkDefault" class="checkbox" type="checkbox" v-model="secDefault"/>
+                    <label class="label" for="chkNone">Disable security</label>
+                    <input id="chkNone" class="checkbox" type="checkbox" v-model="secNone"/>
+                    <label class="label" for="chkCustom">Use custom security</label>
+                    <input id="chkCustom" class="checkbox" type="checkbox" v-model="secCustom"/>
+                </div>
+                <div v-if="secCustom">
+                    <h4 class="none"><strong>Selected security schemes</strong></h4>
+                    <ul>
+                        <li v-for="(scheme,index) in method.security">
+                            <span class="icon" data-balloon="Remove security scheme from operation"><a v-on:click="removeSecScheme(index)"><i class="fa fa-trash"></i></a></span>
+                            <span><strong>{{Object.keys(scheme)[0]}}</strong></span>
+                            <span>{{Object.values(scheme)[0]}}</span>
+                        </li>
+                    </ul>
+                </div>
+            </div>
+
             <div class="method-pane method-pane-links hidden container is-fluid">
                 <div class="card" v-if="!method.links || Object.keys(method.links).length == 0">
                     <div class="card-content">

diff --git a/src/method/method.js b/src/method/method.js
@@ -116,6 +116,10 @@ Vue.component('api-method', {
 				Vue.set(exp,'get',{parameters:[],responses:{default:{description:'Default response'}}});
 			}
         },
+        removeSecScheme : function(index) {
+            this.method.security.splice(index,1);
+            Vue.set(this.method,'security',this.method.security);
+        },
         tagSetup : function() {
             var simpleTags = [];
             for (var t in this.maintags) {
@@ -186,6 +190,66 @@ Vue.component('api-method', {
                 if (!this.method.requestBody.$ref) return this.method.requestBody;
                 return deref(this.method.requestBody, this.$root.container.openapi);
             }
+        },
+        secDefault : {
+            get : function() {
+                return (!this.method.security);
+            },
+            set : function(newVal) {
+                if (newVal) {
+                    Vue.delete(this.method, 'security');
+                }
+                else {
+                    Vue.set(this.method, 'security', []); // disable, works like radio buttons
+                }
+            }
+        },
+        secNone : {
+            get : function() {
+                return (this.method.security && this.method.security.length === 0);
+            },
+            set : function(newVal) {
+                if (newVal) {
+                    Vue.set(this.method, 'security', []);
+                }
+                else {
+                    Vue.delete(this.method, 'security'); // default, works like radio buttons
+                }
+            }
+        },
+        secCustom : {
+            get : function() {
+                return (this.method.security && this.method.security.length > 0);
+            },
+            set : function(newVal) {
+                if (newVal) {
+                    var newSec = clone(this.$root.container.openapi.security);
+                    if (!newSec || newSec.length === 0) {
+                        newSec = [];
+                        for (s in this.$root.container.openapi.components.securitySchemes) {
+                            var scheme = this.$root.container.openapi.components.securitySchemes[s];
+                            var scopes = [];
+                            if (scheme.type === 'oauth2') {
+                                for (var f in scheme.flows) {
+                                    var flow = scheme.flows[f];
+                                    if (flow.scopes) {
+                                        for (sc in flow.scopes) {
+                                            if (scopes.indexOf(s) < 0) scopes.push(sc);
+                                        }
+                                    }
+                                }
+                            }
+                            var entry = {};
+                            entry[s] = scopes;
+                            newSec.push(entry);
+                        }
+                    }
+                    Vue.set(this.method, 'security', newSec);
+                }
+                else {
+                    Vue.delete(this.method, 'security'); // default, works like radio buttons
+                }
+            }
         }
     },
     beforeUpdate : function() {