From 0969f8c5a21da80253223aeee312740a20604063 Mon Sep 17 00:00:00 2001 From: ddangelorb Date: Wed, 6 Oct 2021 14:33:20 -0300 Subject: [PATCH] Updating swagger doc --- index.html | 2 +- swagger.yaml | 50 +++++--------------------------------------------- 2 files changed, 6 insertions(+), 46 deletions(-) diff --git a/index.html b/index.html index d743f89..26f70e9 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ - + diff --git a/swagger.yaml b/swagger.yaml index 4f0393d..9a3310d 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1,7 +1,7 @@ swagger: '2.0' info: description: 'This is a sample JWT authentication service. You can find out more about JWT at [https://jwt.io/](https://jwt.io/). For this sample, you can use the `admin` or `client` users (password: admin and client respectively) to test the authorization filters. Once you have successfully logged in and obtained the token, you should click on the right top button `Authorize` and introduce it with the prefix "Bearer ".' - version: 1.0.0 + version: 1.0.1 title: The authenticator for the Waterproofing Data (WPD) Work Packages contact: email: igsd@warwick.ac.uk @@ -344,48 +344,6 @@ paths: - Authorization: - global deprecated: false - /users/sendadminkeybyemailcemaden: - post: - tags: - - users - summary: ${UserController.sendadminkeybyemailcemaden} - description: This method is used for role 'ROLE_INSTITUTION'. To activate these users, a key is sent to the EduCemandenOrg e-mail and the user should inform this key to proceed. - operationId: sendadminkeybyemailcemadenUsingPOST - consumes: - - application/json - produces: - - '*/*' - parameters: - - name: emailcemaden - in: query - description: Emailcemaden associated to the user - required: true - type: string - allowEmptyValue: false - x-example: The Cemaden e-mail registred in the database. The key will be sent to this e-mail, and the user should be inform this key to proceed. - - name: username - in: query - description: username of the user - required: true - type: string - allowEmptyValue: false - x-example: This is an unique field, and consumers should be aware of it. By convention, WP6 should send the user phone number (i.e. (99)99999-9999). - responses: - '200': - description: OK - '400': - description: Something went wrong - '403': - description: Access denied - '404': - description: User or Email Cemaden not found - '500': - description: Expired or invalid JWT token - security: - - Authorization: - - global - - apiKey: [] - deprecated: false /users/signup: post: tags: @@ -459,14 +417,15 @@ definitions: EduCemadenOrganizations: type: object properties: + activationkey: + type: string + format: uuid active: type: string address: type: string creation_date: type: string - email: - type: string id: type: integer format: int32 @@ -517,6 +476,7 @@ definitions: properties: activationkey: type: string + format: uuid id: type: integer format: int32