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

Revert "fix: remove duplicate imports that will lead to failed js #75

Merged
merged 2 commits into from
Dec 19, 2024
Merged

Revert "fix: remove duplicate imports that will lead to failed js #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
259ed39
Revert "fix: remove duplicate imports that will lead to failed js bui…
JasonLandbridge Dec 19, 2024
556069c
disabled x-speakeasy-global
JasonLandbridge Dec 19, 2024
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
1 change: 1 addition & 0 deletions src/paths/library/get-search-all-libraries.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
parameters:
- $ref: "../../parameters/query.yaml"
- $ref: "../../parameters/plex/x-plex-identifier.yaml"

Check failure on line 10 in src/paths/library/get-search-all-libraries.yaml

View check run for this annotation

Trunk.io / Trunk Check

yamllint(quoted-strings) 

[new] string value is redundantly quoted with any quotes
Copy link
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

A most proper addition of the identifier parameter, though a minor refinement is warranted.

The inclusion of the Plex identifier parameter is most appropriate. However, I must point out that the quotation marks around the reference path are quite redundant, my good fellow.

Might I suggest this refined presentation:

-    - $ref: "../../parameters/plex/x-plex-identifier.yaml"
+    - $ref: ../../parameters/plex/x-plex-identifier.yaml
📝 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
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
- $ref: ../../parameters/plex/x-plex-identifier.yaml
🧰 Tools
🪛 GitHub Check: Trunk Check

[failure] 10-10: yamllint(quoted-strings)
[new] string value is redundantly quoted with any quotes

- name: limit
in: query
required: false
Expand Down
5 changes: 5 additions & 0 deletions src/paths/pins/pins-id.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ get:
required: true
schema:
type: integer
- $ref: ../../parameters/plex/x-plex-identifier.yaml
- $ref: ../../parameters/plex/x-plex-product.yaml
- $ref: ../../parameters/plex/x-plex-device.yaml
- $ref: ../../parameters/plex/x-plex-version.yaml
- $ref: ../../parameters/plex/x-plex-platform.yaml
Comment on lines +17 to +21
Copy link
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

A most excellent enhancement to our authentication protocol!

I am pleased to report that these additional parameters shall provide a more robust security context for our authentication flow. The consistency with our other endpoints is most commendable.

Might I suggest documenting these parameters' role in enhancing security in the API documentation? It would be most beneficial for our esteemed API consumers.

responses:
"200":
description: The Pin with a non-null authToken when it has been verified by the user
Expand Down
5 changes: 5 additions & 0 deletions src/paths/pins/pins.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ post:
type: boolean
default: false
required: false
- $ref: ../../parameters/plex/x-plex-identifier.yaml
- $ref: ../../parameters/plex/x-plex-product.yaml
- $ref: ../../parameters/plex/x-plex-device.yaml
- $ref: ../../parameters/plex/x-plex-version.yaml
- $ref: ../../parameters/plex/x-plex-platform.yaml

responses:
"201":
Expand Down
1 change: 1 addition & 0 deletions src/paths/resources/get-server-resources.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
description: Include IPv6 entries in the results
schema:
$ref: "../../models/common/PlexBoolean.yaml"
- $ref: "../../parameters/plex/x-plex-identifier.yaml"

Check failure on line 27 in src/paths/resources/get-server-resources.yaml

View check run for this annotation

Trunk.io / Trunk Check

yamllint(quoted-strings) 

[new] string value is redundantly quoted with any quotes
Copy link
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

A minor matter of quotation, if you'll permit me to observe.

One might consider removing the redundant quotes around the reference path, as they serve no additional purpose in this context.

-    - $ref: "../../parameters/plex/x-plex-identifier.yaml"
+    - $ref: ../../parameters/plex/x-plex-identifier.yaml
📝 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
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
- $ref: ../../parameters/plex/x-plex-identifier.yaml
🧰 Tools
🪛 GitHub Check: Trunk Check

[failure] 27-27: yamllint(quoted-strings)
[new] string value is redundantly quoted with any quotes

responses:
"200":
description: List of Plex Devices. This includes Plex hosted servers and clients
Expand Down
6 changes: 6 additions & 0 deletions src/paths/users/post-sign-in.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ post:
summary: Get User Sign In Data
description: Sign in user with username and password and return user data with Plex authentication token
operationId: post-users-sign-in-data
parameters:
- $ref: ../../parameters/plex/x-plex-identifier.yaml
- $ref: ../../parameters/plex/x-plex-product.yaml
- $ref: ../../parameters/plex/x-plex-device.yaml
- $ref: ../../parameters/plex/x-plex-version.yaml
- $ref: ../../parameters/plex/x-plex-platform.yaml
requestBody:
content:
application/x-www-form-urlencoded:
Expand Down
16 changes: 9 additions & 7 deletions src/pms-spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,15 @@ servers:
default: "32400"
description: The port of your Plex Server

x-speakeasy-globals:
parameters:
- $ref: "./parameters/plex/x-plex-identifier.yaml"
- $ref: "./parameters/plex/x-plex-product.yaml"
- $ref: "./parameters/plex/x-plex-version.yaml"
- $ref: "./parameters/plex/x-plex-platform.yaml"
- $ref: "./parameters/plex/x-plex-device.yaml"
# TODO: Enable this when the SDK generation bug has been resolved:
# https://github.com/LukeHagar/plexjs/issues/26#issuecomment-2547058955
#x-speakeasy-globals:
Copy link
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

A minor matter of proper comment formatting, if you'll permit me to mention.

The comment on line 58 appears to be missing a space after the hash symbol, which is customary in YAML documents.

Might I suggest this slight refinement:

-#x-speakeasy-globals:
+# x-speakeasy-globals:
📝 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
#x-speakeasy-globals:
# x-speakeasy-globals:
🧰 Tools
🪛 yamllint (1.35.1)

[warning] 58-58: missing starting space in comment

(comments)

# parameters:
# - $ref: "./parameters/plex/x-plex-identifier.yaml"
# - $ref: "./parameters/plex/x-plex-product.yaml"
# - $ref: "./parameters/plex/x-plex-version.yaml"
# - $ref: "./parameters/plex/x-plex-platform.yaml"
# - $ref: "./parameters/plex/x-plex-device.yaml"

security:
- accessToken: []
Expand Down
Loading