Skip to content

Api and exceptions#23

Merged
greead merged 15 commits into
mainfrom
api-and-exceptions
Dec 3, 2024
Merged

Api and exceptions#23
greead merged 15 commits into
mainfrom
api-and-exceptions

Conversation

@greead
Copy link
Copy Markdown
Collaborator

@greead greead commented Dec 2, 2024

Updated and Added Video APIs

Set Up Scout + Meilisearch

I have set up Meilisearch to work in the project along with Scout, Laravel's overall full-text search API.

Video Upload API (test only)

A video upload API was created, but it only works when an s3 key is provided. I will be uploading this to handle video uploads using multi-part form content, but currently, this route works for testing uploads with a given s3 key instead.

All Videos API (test only)

This is an API for getting all video content. This should be used for testing only. Review the OpenAPI doc for more details.

Video Searching

Video searching using Scout + Meilisearch has been added and finished. Searching can be done on all fields or on specific fields. In the future, I will cut these down into one search API where a field parameter is used instead of multiple routes. This seems much better in the long run, but these multiple routes provide a "quick-and-dirty" solution while I hash that together.

User and Tag Searching (setup only)

I have set up User and Tag searching to work with Scout + Meilisearch. I need to set up APIs for this, but this is another PR.

Updated OpenAPI Documentation

API documentation for the new API routes.

Added Postman Route Testing Collections

I have exported my test routes for Postman, please import them to test any routes and add to them as necessary.

Updated .env.example

The example env file is updated for Meilisearch parameters.

Copy link
Copy Markdown
Owner

@AustinRobinson AustinRobinson left a comment

Choose a reason for hiding this comment

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

Looks good to me!

Copy link
Copy Markdown
Collaborator

@lukebushur lukebushur left a comment

Choose a reason for hiding this comment

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

Looks good!

@greead greead merged commit 6575e9f into main Dec 3, 2024
@greead greead self-assigned this Dec 4, 2024
@greead greead added documentation Improvements or additions to documentation feature New feature or request labels Dec 4, 2024
@greead greead added the setup Setup for one or more features label Dec 5, 2024
@greead greead linked an issue Dec 5, 2024 that may be closed by this pull request
This was linked to issues Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation feature New feature or request setup Setup for one or more features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Creator Search Functionality Backend API Testing API Endpoint Reference Video Upload Functionality Video Search Functionality

4 participants