57 lines
1.4 KiB
YAML
57 lines
1.4 KiB
YAML
# SPDX-LICENSE: MIT
|
|
#<syntaxhighlight lang="yaml">
|
|
openapi: 3.0.3
|
|
info:
|
|
title: Verification Endpoint API
|
|
termsOfService: https://policy.recaptime.eu.org/api-terms
|
|
version: doc 0.1.0
|
|
servers:
|
|
- url: https://dev--rtapp-verify-backend.recaptime.autocode.gg
|
|
description: development
|
|
- url: https://rtapp-verify-backend.recaptime.autocode.gg
|
|
description: production
|
|
tags:
|
|
- name: meta
|
|
- name: Index Lookup
|
|
- name: Requires Authentication
|
|
- name: OAuth
|
|
- name: Webhooks
|
|
- name: Admin-only / Debug
|
|
components:
|
|
securitySchemes:
|
|
bearerToken:
|
|
type: http
|
|
scheme: bearer
|
|
paths:
|
|
/ping/:
|
|
get:
|
|
summary: Pings Autocode servers whenever the deployment is up.
|
|
tags:
|
|
- meta
|
|
responses:
|
|
200:
|
|
description: Everything is up.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
ok:
|
|
type: boolean
|
|
example: true
|
|
ping:
|
|
type: string
|
|
example: "Pong!"
|
|
/lookup/me/:
|
|
get:
|
|
security:
|
|
- bearerToken: []
|
|
summary: Query yourself based on current authenticated user.
|
|
tags:
|
|
- Requires Authentication
|
|
- Index Lookup
|
|
/oauth/mediawiki/:
|
|
get:
|
|
summary: |
|
|
Endpoint used by integration bots built by Recap Time Squad for
|
|
#</syntaxhighlight> |