Skip to content
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

Jump to bottom

feat:Title: Update documentation for API endpoints and usage examples #4

Merged
merged 1 commit into from
Sep 30, 2024
Merged

feat:Title: Update documentation for API endpoints and usage examples #4

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
4 changes: 2 additions & 2 deletions src/libs/Forem/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2009,7 +2009,7 @@ paths:
cloudinary_video_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/thumbs-video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f-00001.png
title: The Millstone201
user_id: 1452
video_duration_in_minutes: '2024-09-29'
video_duration_in_minutes: '2024-09-30'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Inconsistency between field name and value type

The video_duration_in_minutes field contains a date value ('2024-09-30') instead of a duration in minutes. This inconsistency could lead to confusion and potential bugs in applications consuming this API.

Consider one of the following solutions:

  1. If the field should represent duration: 
    video_duration_in_minutes: 30
  2. If the field should represent a date: 
    video_publish_date: '2024-09-30'

Please clarify the intended purpose of this field and update either the field name or the value type accordingly.

video_source_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f.m3u8
user:
name: Edgardo "Monroe" \:/ Gusikowski
Expand All @@ -2019,7 +2019,7 @@ paths:
cloudinary_video_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/thumbs-video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f-00001.png
title: A Many-Splendoured Thing202
user_id: 1453
video_duration_in_minutes: '2024-09-29'
video_duration_in_minutes: '2024-09-30'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Repeated inconsistency in video article schema

The video_duration_in_minutes field contains a date value ('2024-09-30') instead of a duration in minutes. This issue is repeated from the previous video article entry, suggesting a systematic problem in the API specification for video articles.

Actions required:

  1. Apply the same correction as suggested in the previous comment.
  2. Review all instances of video_duration_in_minutes in the API specification to ensure consistency.
  3. Consider adding a separate field for the video publish date if that information is necessary.

Example correction:

video_duration_in_minutes: 30
video_publish_date: '2024-09-30'

video_source_url: https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f.m3u8
user:
name: Arlena "Catarina" \:/ Zulauf
Expand Down
Loading