API docs by Redocly

unitn-ap-api (0.1.0)

Download OpenAPI specification:

License: MIT

Health check

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "ts": 0
}

Create an invitation request

Request Body schema: application/json
required
githubId
required
string non-empty
email
required
string <email> ^[A-Za-z0-9._%+-]+@studenti\.unitn\.it$

Responses

Request samples

Content type
application/json
{
  • "githubId": "yifen9",
  • "email": "yifeng.li@studenti.unitn.it"
}

Response samples

Content type
application/json
{
  • "id": "inv_01JABCDE123456789",
  • "status": "pending",
  • "group": "astro-parrots",
  • "role": "leader"
}

Resend verification email

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{}

Verify email token and enqueue invitation

query Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "id": "inv_01JABCDE123456789",
  • "status": "queued",
  • "verification": {
    }
}

GitHub organization webhook

header Parameters
X-GitHub-Event
required
string
X-GitHub-Delivery
required
string
X-Hub-Signature-256
required
string
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }