Browse Source

Updating swagger doc

main
ddangelorb 3 years ago
parent
commit
0969f8c5a2
  1. 2
      index.html
  2. 50
      swagger.yaml

2
index.html

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

50
swagger.yaml

@ -1,7 +1,7 @@
swagger: '2.0' swagger: '2.0'
info: 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 ".' 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 title: The authenticator for the Waterproofing Data (WPD) Work Packages
contact: contact:
email: igsd@warwick.ac.uk email: igsd@warwick.ac.uk
@ -344,48 +344,6 @@ paths:
- Authorization: - Authorization:
- global - global
deprecated: false 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: /users/signup:
post: post:
tags: tags:
@ -459,14 +417,15 @@ definitions:
EduCemadenOrganizations: EduCemadenOrganizations:
type: object type: object
properties: properties:
activationkey:
type: string
format: uuid
active: active:
type: string type: string
address: address:
type: string type: string
creation_date: creation_date:
type: string type: string
email:
type: string
id: id:
type: integer type: integer
format: int32 format: int32
@ -517,6 +476,7 @@ definitions:
properties: properties:
activationkey: activationkey:
type: string type: string
format: uuid
id: id:
type: integer type: integer
format: int32 format: int32

Loading…
Cancel
Save