-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
73 lines (73 loc) · 1.81 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
openapi: 3.0.0
info:
title: BD News API
description: API for fetching headlines from various Bangladeshi news sources
version: 1.0.0
servers:
- url: http://localhost:{port}
description: Local development server
variables:
port:
default: "8080"
description: The port the server is running on
paths:
/:
get:
summary: Serve the frontend HTML
description: Serves the embedded frontend.html file
responses:
'200':
description: Successful response
content:
text/html:
schema:
type: string
/api/headlines:
get:
summary: Get headlines from all sources
description: Fetches and returns headlines from various Bangladeshi news sources
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SourceResponse'
headers:
X-Cache:
schema:
type: string
enum: [HIT, MISS]
description: Indicates whether the response was served from cache
components:
schemas:
SourceResponse:
type: object
properties:
source:
$ref: '#/components/schemas/SourceInfo'
headlines:
type: array
items:
$ref: '#/components/schemas/NewsItem'
SourceInfo:
type: object
properties:
name:
type: string
logo:
type: string
format: uri
homepage:
type: string
format: uri
NewsItem:
type: object
properties:
title:
type: string
url:
type: string
format: uri