Skip to content

events: document follow/follow_state/followers/comments in swagger #776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dylanjeffers merged 1 commit into from
Apr 22, 2026
+289 −0
Merged

events: document follow/follow_state/followers/comments in swagger #776

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
289 changes: 289 additions & 0 deletions api/swagger/swagger-v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1245,6 +1245,276 @@ paths:
"500":
description: Server error
content: {}
/events/{eventId}/comments:
get:
tags:
- events
summary: Get event comments
description:
Paginated stream of top-level comments (with nested replies) for a
remix-contest event. Host-authored top-level comments represent
"post updates"; everything else is a community comment.
operationId: Get Event Comments
security:
- {}
- OAuth2:
- read
parameters:
- name: eventId
in: path
description: An Event ID
required: true
schema:
type: string
- name: offset
in: query
description:
The number of items to skip. Useful for pagination (page number
* limit)
schema:
type: integer
- name: limit
in: query
description: The number of items to fetch
schema:
type: integer
- name: user_id
in: query
description: The user ID of the user making the request
schema:
type: string
- name: sort_method
in: query
description: The sort method
schema:
type: string
default: newest
enum:
- top
- newest
- timestamp
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/track_comments_response"
"400":
description: Bad request
content: {}
"500":
description: Server error
content: {}
/events/{eventId}/follow:
post:
tags:
- events
summary: Follow event
description:
Subscribe to a remix-contest event. Emits a Subscribe/Event
ManageEntity transaction so the indexer records the follow.
operationId: Follow Event
security:
- BearerAuth: []
- BasicAuth: []
- OAuth2:
- write
parameters:
- name: eventId
in: path
description: An Event ID
required: true
schema:
type: string
- name: user_id
in: query
description: The user ID of the user making the request
required: true
schema:
type: string
responses:
"200":
description: Event followed successfully
content:
application/json:
schema:
$ref: "#/components/schemas/write_response"
"401":
description: Unauthorized
content: {}
"404":
description: Event not found
content: {}
"500":
description: Server error
content: {}
delete:
tags:
- events
summary: Unfollow event
description:
Unsubscribe from a remix-contest event. Emits an
Unsubscribe/Event ManageEntity transaction.
operationId: Unfollow Event
security:
- BearerAuth: []
- BasicAuth: []
- OAuth2:
- write
parameters:
- name: eventId
in: path
description: An Event ID
required: true
schema:
type: string
- name: user_id
in: query
description: The user ID of the user making the request
required: true
schema:
type: string
responses:
"200":
description: Event unfollowed successfully
content:
application/json:
schema:
$ref: "#/components/schemas/write_response"
"401":
description: Unauthorized
content: {}
"500":
description: Server error
content: {}
/events/{eventId}/follow_state:
get:
tags:
- events
summary: Get event follow state
description:
Returns whether the current user is subscribed to (follows) a given
remix-contest event, plus the total follower count. Useful for
rendering the Follow / Following button.
operationId: Get Event Follow State
security:
- {}
- OAuth2:
- read
parameters:
- name: eventId
in: path
description: An Event ID
required: true
schema:
type: string
- name: user_id
in: query
description: The user ID of the user making the request
schema:
type: string
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/event_follow_state_response"
"400":
description: Bad request
content: {}
"500":
description: Server error
content: {}
/events/{eventId}/follow-state:
get:
tags:
- events
summary: Get event follow state (hyphenated alias)
description: Hyphenated alias of /events/{eventId}/follow_state.
operationId: Get Event Follow State Alias
security:
- {}
- OAuth2:
- read
parameters:
- name: eventId
in: path
description: An Event ID
required: true
schema:
type: string
- name: user_id
in: query
description: The user ID of the user making the request
schema:
type: string
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/event_follow_state_response"
"400":
description: Bad request
content: {}
"500":
description: Server error
content: {}
/events/{eventId}/followers:
get:
tags:
- events
summary: Get event followers
description:
Returns the list of users subscribed to a given remix-contest
event, ordered by each follower's own follower count so the
most-followed fans surface first. Used by the contest page's
Followers card (avatar stack + leaderboard).
operationId: Get Event Followers
security:
- {}
- OAuth2:
- read
parameters:
- name: eventId
in: path
description: An Event ID
required: true
schema:
type: string
- name: offset
in: query
description:
The number of items to skip. Useful for pagination (page number
* limit)
schema:
type: integer
- name: limit
in: query
description: The number of items to fetch
schema:
type: integer
- name: user_id
in: query
description: The user ID of the user making the request
schema:
type: string
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/followers_response"
"400":
description: Bad request
content: {}
"500":
description: Server error
content: {}
/events/unclaimed_id:
get:
tags:
Expand Down Expand Up @@ -11522,6 +11792,25 @@ components:
type: array
items:
$ref: "#/components/schemas/event"
event_follow_state:
required:
- is_followed
- follower_count
type: object
properties:
is_followed:
type: boolean
description:
Whether the authenticated / requested user is currently
subscribed to this event.
follower_count:
type: integer
description: Total number of users following this event.
event_follow_state_response:
type: object
properties:
data:
$ref: "#/components/schemas/event_follow_state"
version_metadata:
required:
- service
Expand Down
Loading