openapi: 3.0.
info:
version: 1.0.0
title: Proyecto STRAPPS COMMUNITY Entidad de Aula Virtual
description: API de la Entida de Aula Virtual para STRAPPS COMMUNITY
servers:
- url: [Link]
description: pagina de strapps
tags:
- name: login
description: Endpoint para las solicitudes de ingreso
- name: administrador
description: Endpoint para las solicitudes del administrador
- name: instructor
description: Endpoint para las solicitudes del instructor
components:
securitySchemes:
OAuth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: [Link]
tokenUrl: [Link]
scopes:
usuario: Permisos para partes especificas de la api
instructor: Permisos para partes especificas de la api
administrador: Todos los permisos
responses:
400Error:
description: Solicitud incorrecta
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
description: Descripcion del error
example: 'Peticion no valida, favor de validar su informacion'
401Error:
description: 'No autorizado'
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
description: Descripcion del error
example: 'Es necesario autenticar para obtener la respuesta
solicitada.'
404Error:
description: 'Recurso no encontrado'
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
description: 'Descripcion del error'
example: 'El servidor no pudo encontrar el contenido solicitado'
500Error:
description: 'Error interno de servidor'
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
description: 'Descripcion del error'
example: 'Oppps, no se pudo procesar'
security:
#- BasicAuth: []
#- ApiKeyAuth: []
- OAuth2: []
# - read
# - write
paths: #puntos finales (rutas) y metodos (verbos) http /Punto final
#cuando un punto final tenga corchetes significa que nesecita un parametro
/usuario/taller:
get:
tags:
- Aula virtual
description: Obiene los talleres del usuario REVISADO
summary: Obtiene los talleres del usuario
parameters:
- name: token
in: header
required: true
description: Token de sesión
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
idtaller:
type: integer
example: 1
description: Id de taller
taller:
type: string
example: SCRUM MASTER
description: Nombre del taller
"400":
description: solicitud incorrecta
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Volver intentar
'401':
description: Error de autenticacion
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
example: Error De Autenticación
description: Hubo un error en el proceso
'500':
description: Error
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
example: Error No Se Ha Podido Procesar, Intente Más Tarde
description: Error en el proceso
/usuario/sesion/{idTaller}:
get:
tags:
- Aula virtual
description: Obtiene las sesiones del usuario por idtaller
summary: Obtiene las sesiones del usuario
parameters:
- name: token
in: header
required: true
description: Token de sesión
schema:
type: string
- name: idTaller
in: path
required: true
description: Id del Taller
schema:
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
idSesión:
type: integer
example: 1
description: Id de la sesión
sesión:
type: string
example: Sesión 1
description: Descripción de la sesión
"400":
description: solicitud incorrecta
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Volver intentar
'401':
description: Error de autenticacion
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
example: Error De Autenticación
description: Hubo un error en el proceso
'500':
description: Error
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
example: Error No Se Ha Podido Procesar, Intente Más Tarde
description: Error en el proceso
/usuario/sesion/inicio:
get:
tags:
- Aula virtual
description: Obtiene el inicio de las sesiones del usuario por taller
summary: Obtiene el inicio de las sesiones del usuario
parameters:
- name: token
in: header
required: true
description: Token de Inicio
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
inicio:
type: string
example: 10-59 am 05/07/2022
description: inicio de sección
duracción:
type: string
example: 2 horas
description: duracción de la reunión
id reunión:
type: string
example: 5687654
description: id de la reunión
passcore:
type: string
example: 654388
description: Clave de acesso
"400":
description: solicitud incorrecta
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Volver intentar
'401':
description: Error de autenticacion
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
example: Error De Autenticación
description: Hubo un error en el proceso
'500':
description: Error
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
example: Error No Se Ha Podido Procesar, Intente Más Tarde
description: Error en el proceso
/usuario/seccion/link:
get:
tags:
- Aula virtual
description: Obtiene información de la reunion con el link del enlace
summary: Obtiene información del enlace por usuario
parameters:
- name: token
in: header
required: true
description: Token del inicio de sesión
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
plataforma:
type: string
example: [Link]
description: Enlace de la reunion
"400":
description: solicitud incorrecta
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Volver intentar
'401':
description: Error de autenticacion
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
example: Error De Autenticación
description: Hubo un error en el proceso
'500':
description: Error
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
example: Error No Se Ha Podido Procesar, Intente Más Tarde
description: Error en el proceso