Browse Source

API: Rename properties for consistency

* Rename Topic last_visit_time to last_visited_at

  For consistency with other DateTime properties.

* Rename Comment votes to vote_count

  For consistency with Topic property names.

* Rename pagination num_items to item_count

  For consistency with other "count" properties.
merge-requests/170/head
Andrew Shu 3 months ago
parent
commit
a66696c337
  1. 12
      tildes/openapi_beta.yaml
  2. 6
      tildes/tildes/views/api/beta/comment.py
  3. 4
      tildes/tildes/views/api/beta/topic.py
  4. 6
      tildes/tildes/views/api/beta/user.py

12
tildes/openapi_beta.yaml

@ -274,7 +274,7 @@ components:
- ignored - ignored
- official - official
- tags - tags
- last_visit_time
- last_visited_at
properties: properties:
id: id:
type: string type: string
@ -326,7 +326,7 @@ components:
type: array type: array
items: items:
type: string type: string
last_visit_time:
last_visited_at:
type: string type: string
nullable: true nullable: true
@ -339,7 +339,7 @@ components:
- rendered_html - rendered_html
- created_at - created_at
- edited_at - edited_at
- votes
- vote_count
- removed - removed
- deleted - deleted
- exemplary - exemplary
@ -366,7 +366,7 @@ components:
edited_at: edited_at:
type: string type: string
nullable: true nullable: true
votes:
vote_count:
type: integer type: integer
removed: removed:
type: boolean type: boolean
@ -410,11 +410,11 @@ components:
Pagination: Pagination:
type: object type: object
required: required:
- num_items
- item_count
- next_link - next_link
- prev_link - prev_link
properties: properties:
num_items:
item_count:
type: integer type: integer
description: The number of items returned in this response. description: The number of items returned in this response.
next_link: next_link:

6
tildes/tildes/views/api/beta/comment.py

@ -31,7 +31,7 @@ def comment_to_api_dict(request: Request, comment: Comment) -> dict:
created_time = None created_time = None
edited_time = None edited_time = None
rendered_html = None rendered_html = None
votes = 0
vote_count = 0
exemplary = None exemplary = None
by_op = None by_op = None
by_me = None by_me = None
@ -46,7 +46,7 @@ def comment_to_api_dict(request: Request, comment: Comment) -> dict:
comment.last_edited_time.isoformat() if comment.last_edited_time else None comment.last_edited_time.isoformat() if comment.last_edited_time else None
) )
rendered_html = comment.rendered_html rendered_html = comment.rendered_html
votes = comment.num_votes
vote_count = comment.num_votes
exemplary = comment.is_label_active("exemplary") exemplary = comment.is_label_active("exemplary")
by_me = request.user == comment.user if request.user else False by_me = request.user == comment.user if request.user else False
@ -75,7 +75,7 @@ def comment_to_api_dict(request: Request, comment: Comment) -> dict:
"rendered_html": rendered_html, "rendered_html": rendered_html,
"created_at": created_time, "created_at": created_time,
"edited_at": edited_time, "edited_at": edited_time,
"votes": votes,
"vote_count": vote_count,
"removed": is_removed, "removed": is_removed,
"deleted": is_deleted, "deleted": is_deleted,
"exemplary": exemplary, "exemplary": exemplary,

4
tildes/tildes/views/api/beta/topic.py

@ -44,7 +44,7 @@ def topic_to_api_dict(topic: Topic) -> dict:
"ignored": topic.user_ignored, "ignored": topic.user_ignored,
"official": topic.is_official, "official": topic.is_official,
"tags": topic.tags, "tags": topic.tags,
"last_visit_time": (
"last_visited_at": (
topic.last_visit_time.isoformat() if topic.last_visit_time else None topic.last_visit_time.isoformat() if topic.last_visit_time else None
), ),
} }
@ -109,7 +109,7 @@ def get_topics(request: Request) -> dict: # noqa
response = { response = {
"topics": processed_topics, "topics": processed_topics,
"pagination": { "pagination": {
"num_items": len(processed_topics),
"item_count": len(processed_topics),
"next_link": next_link, "next_link": next_link,
"prev_link": prev_link, "prev_link": prev_link,
}, },

6
tildes/tildes/views/api/beta/user.py

@ -100,7 +100,7 @@ def get_user(request: Request) -> dict: # noqa
"user": _user_to_api_dict(user), "user": _user_to_api_dict(user),
"history": processed_results, "history": processed_results,
"pagination": { "pagination": {
"num_items": len(processed_results),
"item_count": len(processed_results),
"next_link": next_link, "next_link": next_link,
"prev_link": prev_link, "prev_link": prev_link,
}, },
@ -156,7 +156,7 @@ def get_user_comments(request: Request) -> dict:
response = { response = {
"comments": processed_comments, "comments": processed_comments,
"pagination": { "pagination": {
"num_items": len(processed_comments),
"item_count": len(processed_comments),
"next_link": next_link, "next_link": next_link,
"prev_link": prev_link, "prev_link": prev_link,
}, },
@ -212,7 +212,7 @@ def get_user_topics(request: Request) -> dict:
response = { response = {
"topics": processed_topics, "topics": processed_topics,
"pagination": { "pagination": {
"num_items": len(processed_topics),
"item_count": len(processed_topics),
"next_link": next_link, "next_link": next_link,
"prev_link": prev_link, "prev_link": prev_link,
}, },

Loading…
Cancel
Save