-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSeguridad.raml
166 lines (159 loc) · 5.03 KB
/
Seguridad.raml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
#%RAML 1.0
#===============================================================
# References:
# - RAML Specification - http://raml.org/spec.html
# - RAML Projects - http://raml.org/projects.html
# - RAML Tools - http://www.apihub.com/raml-tools
#===============================================================
title: Empleados API
version: v1
baseUri: http://api.mtis.org
#List of media type to support
#mediaType: application/json
#List of protocols to support for baseUri
#protocols: [ HTTP, HTTPS ]
#===============================================================
# API documentation
#===============================================================
types:
Seguridad:
description: Objeto seguridad para el acceso a la gestion de la 'empresa'.
type: object
properties:
DNI:
type: string
minLength: 9
maxLength: 9
required: true
Sala:
type: string
required: true
Error:
description: Objeto utilziado para transmitir un mensaje y codigo en caso de algun error.
type: object
properties:
code: integer
message: string
#===============================================================
# API documentation
#===============================================================
documentation:
- title: Gestion Empleados
content: | #Esto es un prototipo de API para la Gestion de Empleados de una empresa.
#===============================================================
# API resource definitions
#===============================================================
/seguridad:
/asignarPermisos:
post:
displayName: AsignarPermisos
description: Concede permisos de acceso enlazando una sala con un empleado
queryParameters:
RestKey:
description: Una restkey valida almacenada en la bdd (Concede permisos para realizar al operacion)
type: string
required: true
DNI:
description: Un DNI valido de un empleado registrado.
type: string
minLength: 9
maxLength: 9
required: true
Sala:
description: Un nombre de una sala
type: string
required: true
responses:
200:
description: Se han asociado la sala y el empleado correctamente.
body:
application/json:
type: boolean
400:
description: Ha ocurrido algun error al realizar la operacion.
body:
application/json:
type: Error
/validarUsuario:
get:
displayName: ValidateUser
description: Validar el acceso a una sala por parte de un usuario a partir de su DNI y el nombre de la Sala
queryParameters:
RestKey:
description: Una restkey valida almacenada en la bdd (Concede permisos para realizar al operacion)
type: string
required: true
DNI:
description: DNI del empleado interesado.
type: string
required: true
Sala:
description: Sala a comprobar
type: string
required: true
responses:
200:
description: El empleado puede acceder a la sala.
body:
application/json:
type: boolean
400:
description: Ha ocurrido un error o el usuario no puede acceder
body:
application/json:
type: Error
/eliminarPermisos:
delete:
displayName: eliminarPermisos
description: Eliminar el acceso del usuario a una sala
queryParameters:
RestKey:
description: Una restkey valida almacenada en la bdd (Concede permisos para realizar al operacion)
type: string
required: true
DNI:
description: DNI del empleado
type: string
required: true
Sala:
description: Nombre de la sala
type: string
required: true
responses:
200:
description: Se han eliminado los permisos correctamente
body:
application/json:
type: boolean
400:
description: Ha ocurrido un error al modificar el empleado.
body:
application/json:
type: Error
/obtenerNiveles:
get:
displayName: obtenerNiveles
description: Obtiene la lista de salas a las que puede acceder un empleado.
queryParameters:
RestKey:
description: Una restkey valida almacenada en la bdd (Concede permisos para realizar al operacion)
type: string
required: true
DNI:
description: DNI del empleado a consultar.
type: string
required: true
responses:
200:
description: Lista de salas obtenida
body:
application/json:
type: array
items: string
minItems: 0
uniqueItems: false
400:
description: Ha ocurrido algún error durante la consulta.
body:
application/json:
type: Error