Browse Source

Updating swagger doc

main
ddangelorb 3 years ago
parent
commit
cc49a58dee
  1. 2
      index.html
  2. 2
      src/main/java/org/waterproofingdata/wpdauth/controller/UsersController.java
  3. 4
      swagger.yaml

2
index.html

@ -1,5 +1,5 @@
<!DOCTYPE html>
<!-- V1.0.3.0.2-->
<!-- V1.0.3.0.3-->
<html lang="en">
<head>

2
src/main/java/org/waterproofingdata/wpdauth/controller/UsersController.java

@ -110,7 +110,7 @@ public class UsersController {
name = "activationkey",
type = "String",
value = "Activation Key to activate the user",
example = "If user belongs to 'ROLE_INSTITUTION' the key should be collected from the emailcemaden, previously sent by ${UserController.sendadminkeybyemailcemaden}. If the user belongs to 'ROLE_CLIENT' the key should be provided by a 'ROLE_INSTITUTION' valid user.",
example = "If user belongs to 'ROLE_INSTITUTION' the key should be collected from the EduCemadenOrganization registration. If the user belongs to 'ROLE_CLIENT' the key should be provided by a 'ROLE_INSTITUTION' valid user.",
required = true
)
@RequestParam String activationkey

4
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.1
version: 1.0.2
title: The authenticator for the Waterproofing Data (WPD) Work Packages
contact:
email: igsd@warwick.ac.uk
@ -237,7 +237,7 @@ paths:
required: true
type: string
allowEmptyValue: false
x-example: If user belongs to 'ROLE_INSTITUTION' the key should be collected from the emailcemaden, previously sent by ${UserController.sendadminkeybyemailcemaden}. If the user belongs to 'ROLE_CLIENT' the key should be provided by a 'ROLE_INSTITUTION' valid user.
x-example: If user belongs to 'ROLE_INSTITUTION' the key should be collected from the EduCemadenOrganization registration. If the user belongs to 'ROLE_CLIENT' the key should be provided by a 'ROLE_INSTITUTION' valid user.
- name: username
in: query
description: username of the user

Loading…
Cancel
Save