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 24, 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
6 changes: 3 additions & 3 deletions src/libs/Luma/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ paths:
default:
value:
prompt: A serene lake surrounded by mountains at sunset
aspect_ratio: '2024-09-23T16:09:00.0000000+00:00'
aspect_ratio: '2024-09-24T16:09:00.0000000+00:00'
Copy link

Choose a reason for hiding this comment

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

Incorrect data type for aspect_ratio field

The aspect_ratio field is currently set to a timestamp value ('2024-09-24T16:09:00.0000000+00:00'), which is inconsistent with the expected format for an aspect ratio. This could lead to errors or unexpected behavior when using the API.

Please update the aspect_ratio field to use a valid aspect ratio string. For example:

-                  aspect_ratio: '2024-09-24T16:09:00.0000000+00:00'
+                  aspect_ratio: '16:9'

Also, ensure that the aspect_ratio field in the GenerationRequest schema (defined later in the file) correctly references the AspectRatio schema, which should contain valid aspect ratio options.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
aspect_ratio: '2024-09-24T16:09:00.0000000+00:00'
aspect_ratio: '16:9'

loop: true
keyframes:
frame0:
Expand Down Expand Up @@ -233,7 +233,7 @@ components:
version: v1.6
request:
prompt: A serene lake surrounded by mountains at sunset
aspect_ratio: '2024-09-23T16:09:00.0000000+00:00'
aspect_ratio: '2024-09-24T16:09:00.0000000+00:00'
Copy link

Choose a reason for hiding this comment

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

Incorrect example value for aspect_ratio field in ListGenerationResponse

The aspect_ratio field in the ListGenerationResponse example is set to a timestamp value ('2024-09-24T16:09:00.0000000+00:00'), which is inconsistent with the expected format for an aspect ratio. This could mislead API users.

Please update the aspect_ratio field in the example to use a valid aspect ratio string. For example:

-              aspect_ratio: '2024-09-24T16:09:00.0000000+00:00'
+              aspect_ratio: '16:9'

Ensure that this example aligns with the actual AspectRatio schema defined in the components section.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
aspect_ratio: '2024-09-24T16:09:00.0000000+00:00'
aspect_ratio: '16:9'

loop: true
keyframes:
frame0:
Expand Down Expand Up @@ -351,7 +351,7 @@ components:
version: v1.6
request:
prompt: A serene lake surrounded by mountains at sunset
aspect_ratio: '2024-09-23T16:09:00.0000000+00:00'
aspect_ratio: '2024-09-24T16:09:00.0000000+00:00'
Copy link

Choose a reason for hiding this comment

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

Incorrect example value for aspect_ratio field in Generation schema

The aspect_ratio field in the Generation schema example is set to a timestamp value ('2024-09-24T16:09:00.0000000+00:00'), which is inconsistent with the expected format for an aspect ratio. This could mislead API users and potentially cause issues in implementations.

Please update the aspect_ratio field in the example to use a valid aspect ratio string. For example:

-          aspect_ratio: '2024-09-24T16:09:00.0000000+00:00'
+          aspect_ratio: '16:9'

Ensure that this example aligns with the AspectRatio schema defined in the components section.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
aspect_ratio: '2024-09-24T16:09:00.0000000+00:00'
aspect_ratio: '16:9'

loop: true
keyframes:
frame0:
Expand Down