changeset 170:9f1b84b712a8

fix: updated API spec
author Thomas Junk <thomas.junk@intevation.de>
date Tue, 10 Jul 2018 12:03:33 +0200
parents 9fcfccb18b16
children 61f6c0add246
files api/server/swagger.yaml client/README.md client/src/components/Sidebar.vue
diffstat 3 files changed, 17 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/api/server/swagger.yaml	Tue Jul 10 10:36:50 2018 +0200
+++ b/api/server/swagger.yaml	Tue Jul 10 12:03:33 2018 +0200
@@ -28,16 +28,16 @@
     post:
       summary: Create a new user
       responses:
-        '200':
-          description: Success response
+        '201':
+          description: user created
       tags: 
         - users
-  /users/{id}:
+  /users/{login}:
     get:
-      summary: Get user with id
+      summary: Get user with login
       parameters:
         - in: path
-          name: id
+          name: login
           schema:
             type: integer
           required: true
@@ -47,10 +47,10 @@
       tags: 
         - users
     put:
-      summary: Update user with id
+      summary: Update user with login
       parameters:
         - in: path
-          name: id
+          name: login
           schema:
             type: integer
           required: true
@@ -60,10 +60,10 @@
       tags: 
         - users
     patch:
-      summary: Partially update user with id
+      summary: Partially update user with login
       parameters:
         - in: path
-          name: id
+          name: login
           schema:
             type: integer
           required: true
@@ -73,10 +73,10 @@
       tags: 
         - users
     delete:
-      summary: Delete user with id
+      summary: Delete user with login
       parameters:
         - in: path
-          name: id
+          name: login
           schema:
             type: integer
           required: true
@@ -85,15 +85,9 @@
           description: Success response
       tags: 
         - users
-  /users/{id}/passwordreset:
+  /users/passwordreset:
     post:
-      summary: Reset password for user with id
-      parameters:
-        - in: path
-          name: id
-          schema:
-            type: integer
-          required: true
+      summary: Reset password for users
       responses:
         '200':
           description: Success response
--- a/client/README.md	Tue Jul 10 10:36:50 2018 +0200
+++ b/client/README.md	Tue Jul 10 12:03:33 2018 +0200
@@ -44,3 +44,6 @@
     see [Vue CLI Plugin Docs](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-e2e-nightwatch)
     and see also [Nightwatch documentation](http://nightwatchjs.org/gettingstarted#geckodriver)
 
+* Swagger API Specification
+
+  `yarn swagger` opens the current API specification
--- a/client/src/components/Sidebar.vue	Tue Jul 10 10:36:50 2018 +0200
+++ b/client/src/components/Sidebar.vue	Tue Jul 10 12:03:33 2018 +0200
@@ -43,7 +43,7 @@
     },
     userinfoStyle() {
       return {
-        user:true,
+        user: true,
         "d-inline-flex": true,
         "visibility-extended": !this.collapsed,
         "visibility-collapsed": this.collapsed