Skip to content

feat(files): add storage and file management API methods#80

Open
briansumma wants to merge 2 commits intoNorthShoreAutomation:mainfrom
briansumma:feat/files-api-extensions
Open

feat(files): add storage and file management API methods#80
briansumma wants to merge 2 commits intoNorthShoreAutomation:mainfrom
briansumma:feat/files-api-extensions

Conversation

@briansumma
Copy link
Copy Markdown
Contributor

File Storage API Extensions

Summary

This PR extends the FilesSpec class with methods for managing files at the storage level
and adds support for media processing jobs. It also includes minor docstring formatting fixes.

New Features

  • Create and fetch files directly at the storage level
  • Retrieve format components for assets
  • Get deleted file sets and formats
  • Create mediainfo extraction jobs
  • Create transcoding jobs for proxies and keyframes

Minor Improvements

  • Fixed docstring formatting (single quotes → triple quotes)
  • Added type hints (Optional, Literal)
  • Added method alias for backward compatibility

Testing

All new methods have been tested against the API with various scenarios:

  • Creating files with and without assets
  • Retrieving files from different storage types
  • Processing various media formats

Documentation

All new methods include comprehensive docstrings with:

  • Clear descriptions of functionality
  • Argument details
  • Return type information
  • Error handling notes

Add several new methods to FilesSpec:
- Storage file creation and retrieval functions
- Format components and deleted objects retrieval
- Media processing job creation methods (mediainfo, transcoding)
- Fix docstring formatting for existing methods

This extends the API to support storage-level operations and improves media
processing workflow.
@nsa-brant
Copy link
Copy Markdown
Member

Just some notes for the entire library, probably thinking we should go with 'list' for multiple objects and maybe get for single objects. Need to update all the endpoints to follow this pattern, for now we can start here. but need to make a consistent pattern thoughout

@briansumma
Copy link
Copy Markdown
Contributor Author

I was avoiding list, so as not to shadow the built-in list. I can change it... I literally chose fetch because it's a synonym of get and I am too old to be clever.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants