aboutsummaryrefslogtreecommitdiffhomepage
path: root/common/graphql/schema.graphql
blob: 2ee136571af4e07e965965843083cb0383d7e80e (plain)
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
scalar DateTime

"""
Represents a feed subscription in the system
"""
type Feed {
  """
  Unique identifier for the feed
  """
  id: ID!

  """
  URL of the RSS/Atom feed
  """
  url: String!

  """
  Title of the feed (extracted from feed metadata)
  """
  title: String!

  """
  Timestamp when the feed was last fetched
  """
  fetchedAt: DateTime!

  """
  Articles belonging to this feed
  """
  articles: [Article!]!
}

"""
Represents an individual article/post from a feed
"""
type Article {
  """
  Unique identifier for the article
  """
  id: ID!

  """
  ID of the feed this article belongs to
  """
  feedId: ID!

  """
  GUID from the RSS/Atom feed (unique identifier from feed)
  """
  guid: String!

  """
  Title of the article
  """
  title: String!

  """
  URL/link to the original article
  """
  url: String!

  """
  Whether the article has been marked as read
  """
  isRead: Boolean!

  """
  The feed this article belongs to
  """
  feed: Feed!
}

"""
Root query type for reading data
"""
type Query {
  """
  Get all feeds with their metadata
  """
  feeds: [Feed!]!

  """
  Get all unread articles across all feeds
  """
  unreadArticles: [Article!]!

  """
  Get all read articles across all feeds
  """
  readArticles: [Article!]!

  """
  Get a specific feed by ID
  """
  feed(id: ID!): Feed

  """
  Get a specific article by ID
  """
  article(id: ID!): Article
}

"""
Root mutation type for modifying data
"""
type Mutation {
  """
  Add a new feed subscription
  """
  addFeed(url: String!): Feed!

  """
  Remove a feed subscription and all its articles
  """
  removeFeed(id: ID!): Boolean!

  """
  Mark an article as read
  """
  markArticleRead(id: ID!): Article!

  """
  Mark an article as unread
  """
  markArticleUnread(id: ID!): Article!

  """
  Mark all articles in a feed as read
  """
  markFeedRead(id: ID!): Feed!

  """
  Mark all articles in a feed as unread
  """
  markFeedUnread(id: ID!): Feed!
}