Skip to content

Commit

Permalink
feat(services): added link to webmail and unread emails number (#25)
Browse files Browse the repository at this point in the history
* feat(services): added link to webmail and unread emails number

* fix unreadEmails string, not number
  • Loading branch information
Bri74 committed Apr 30, 2024
1 parent 090684d commit 7a50b02
Showing 1 changed file with 57 additions and 1 deletion.
58 changes: 57 additions & 1 deletion openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: Polito Students API
version: 1.0.0-ALPHA.61
version: 1.0.0-ALPHA.62
servers:
- url: https://app.didattica.polito.it/api
description: Production server (uses live data)
Expand Down Expand Up @@ -3023,6 +3023,47 @@ paths:
$ref: '#/components/schemas/Survey'
required: [ data ]

/linkToWebmail:
get:
tags:
- Webmail
summary: Retrieve student's webmail link | Recupera il link alla webmail dello studente
operationId: getWebmailLink
responses:
200:
description: Success
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/LinkToWebmail'
required: [ data ]
500:
$ref: '#/components/responses/ErrorResponse'

/unreadEmails:
get:
tags:
- Webmail
summary: Retrieve student's unread emails number | Recupera il numero di email non lette dello studente
operationId: getUnreadEmailslNumber
responses:
200:
description: Success
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/EmailBadge'
required: [ data ]
500:
$ref: '#/components/responses/ErrorResponse'


components:
parameters:
bookingIdParam:
Expand Down Expand Up @@ -5522,3 +5563,18 @@ components:
course:
$ref: '#/components/schemas/SurveyCourseRef'
required: [ id, title, subtitle, category, type, isMandatory, isCompiled, compileDate, url, startsAt, endsAt ]

LinkToWebmail:
type: object
properties:
url:
type: string
example: 'https://...'
required: [ url ]
EmailBadge:
type: object
properties:
unreadEmails:
type: string
example: "99+"
required: [ unreadEmails ]

0 comments on commit 7a50b02

Please sign in to comment.