Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Add optional peaks key to AudioDetail interface #998

Merged
merged 2 commits into from
Feb 25, 2022
Merged

Add optional peaks key to AudioDetail interface #998

merged 2 commits into from
Feb 25, 2022

Conversation

ChrisCoastal
Copy link
Contributor

Fixes

Fixes #996 by @obulat

Description

Adds optional peaks key to AudioDetail interface which will be soon used for the waveform. Type set to 'any'.

Testing Instructions

No testing written.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@ChrisCoastal ChrisCoastal requested a review from a team as a code owner February 23, 2022 18:54
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

Thank you so much for the contribution, and welcome to Openverse! Once you've updated the type to number[] this should be ready for approving 🎉

@@ -97,6 +97,7 @@ export interface AudioDetail extends BaseMediaDetail<'audio'> {
sample_rate?: number
alt_files?: any
filetype?: string
peaks?: any
Copy link
Contributor

Choose a reason for hiding this comment

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

We can actually set this to number[] specifically 🙂

Suggested change
peaks?: any
peaks?: number[]

It might also be always defined, in which case we could remove the ? but I'm not confident about that... and it's better safe than sorry when working with API responses anyway.

Copy link
Member

Choose a reason for hiding this comment

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

@ChrisCoastal just wanted to make sure you saw this review. Thanks for your contribution so far!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello @sarayourfriend and @zackkrida and thank you for the feedback and welcome to Openverse! I am very thankful for the guidance and opportunity. Apologies, as I've just seen this followup now, so I will changes and submit. Thanks!

@sarayourfriend sarayourfriend added documentation 💻 aspect: code Concerns the software code in the repository 🟩 priority: low Low priority and doesn't need to be rushed 🌟 goal: addition Addition of new feature and removed documentation labels Feb 23, 2022
Updated type expected by peaks key in AudioDetail interface to a number array.
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

Awesome, thank you! 🎉

@sarayourfriend
Copy link
Contributor

@zackkrida do you feel comfortable if we merge this before the deployment? It's just a type change so as long as CI type check is passing we should be good. Feel free to merge if you're comfortable with it.

@zackkrida zackkrida merged commit 3ab0347 into WordPress:main Feb 25, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository 🌟 goal: addition Addition of new feature 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add peaks to the AudioDetail interface
3 participants