Initial api definition
This commit is contained in:
37
api.yaml
Normal file
37
api.yaml
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
openapi: 3.0.3
|
||||||
|
info:
|
||||||
|
title: TheAdversary api
|
||||||
|
description: TheAdversary api
|
||||||
|
version: 1.0.0
|
||||||
|
servers:
|
||||||
|
- url: 'https://localhost:8080'
|
||||||
|
paths:
|
||||||
|
/recent:
|
||||||
|
get:
|
||||||
|
summary: Get recent articles
|
||||||
|
parameters:
|
||||||
|
- in: query
|
||||||
|
name: limit
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
description: Limit of recent articles to return
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
title:
|
||||||
|
type: string
|
||||||
|
description: Title of the article
|
||||||
|
summary:
|
||||||
|
type: string
|
||||||
|
description: A short overview summary of the article
|
||||||
|
image:
|
||||||
|
type: string
|
||||||
|
description: Link to a preview image
|
||||||
|
link:
|
||||||
|
type: string
|
||||||
|
description: Link to the article itself
|
||||||
Reference in New Issue
Block a user