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.

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

feat!: Overhauled api model #16

Merged
merged 22 commits into from
Feb 8, 2024
Merged

feat!: Overhauled api model #16

merged 22 commits into from
Feb 8, 2024

Conversation

dabobert
Copy link
Contributor

@dabobert dabobert commented Feb 3, 2024

Breaking Changes: Overhauled api model

πŸ“š Description of Changes

  • Breaking Changes
    • fullpath param is moved from reservation to complete endpoint
    • fullpath param renamed to path_to_file to make it consistent between client and server
    • The bucket uuid is required for all endpoints
    • server error http status codes
    • restructured how complete and update_metadata receive params in anticipation of the data model change
      • a data profile is create via Eivu::Client::Utils.generate_data_profile
  • Non Breaking Changes
    • fixed specs so all are passing

❓ Motivation and Context

Importing via the ruby multithread client highlighted the deficiencies with the work thus far

  • the same file was unable to be uploaded to multiple buckets: was fixed by including bucket_uuid in the uri
  • a single resource was unable to exist on multiple releases: fixed in next PR

πŸ” Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Chore (refactor, documentation update, etc)

πŸ’³ Does This Create Any New Technical Debt?

  • No
  • Yes

βœ… Global Checklist:

  • Anyone can merge this pull request on my behalf.
  • My code follows the code style of this project.
  • My change requires a change to the documentation and I've updated the docs.
  • I have added tests that cover my changes.
  • All new and existing unit tests passed.
  • All new and existing integration tests passed.
  • All new and existing smoke tests passed.
  • I have run this code locally to test.
  • I have thoughtfully considered the security implications of this change.
  • Does this change expose new, public-facing endpoints that do not have authentication?

- adding bucket_uuid to configuration
- updating error messages in configuration
- for clarity within client and cloud file
- changed how the payload is sent to the complete and update_metadata endpoint
- moved data_profile to Utils
- cleaned up client spec
@dabobert dabobert merged commit 5e7150b into master Feb 8, 2024
1 check passed
@dabobert dabobert deleted the feature/overhaul-api-model branch February 19, 2024 23:48
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.

None yet

1 participant