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

Management API Resources Refactor #359

Open
Miles-Garnsey opened this issue Aug 23, 2023 · 0 comments
Open

Management API Resources Refactor #359

Miles-Garnsey opened this issue Aug 23, 2023 · 0 comments
Labels
ready Issues in the state 'ready' refactoring

Comments

@Miles-Garnsey
Copy link
Member

Miles-Garnsey commented Aug 23, 2023

The resources in management API are a little unwieldy given we are moving to have 3 API versions.

Ideally, the following might be a nicer structure:

  1. models packages should exist under the API versions they relate to. Having a single models package might reduce duplication, but it doesn't allow the API to evolve as safely.
  2. Nothing should be shared between API versions.
  3. All Resources classes should sit under a package corresponding to the API version they relate to. V1 APIs are currently in the resources root package.
  4. The tests for resources are largely sitting under a root directory and do not mirror the structure of the production code. in one instance, tests for v0 and v1 endpoints are in the same class, which makes tracing test failures challenging without extensive knowledge of the codebase.
@Miles-Garnsey Miles-Garnsey added ready Issues in the state 'ready' refactoring labels Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready Issues in the state 'ready' refactoring
Projects
Status: Ready
Development

No branches or pull requests

1 participant