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

[Refactor]:: Refactor the API response for organization to align with the established source of truth. #630

Open
Dev-Tonia opened this issue Feb 28, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request mentor approved

Comments

@Dev-Tonia
Copy link
Contributor

Dev-Tonia commented Feb 28, 2025

Description:

The return type of the organization endpoint needs to be updated to provide a more consistent with the established source of truth.

Acceptance Criteria:

  • The organisation creation endpoint should match, established source of truth.
  • Refactor the Get all the organisations endpoint to use the authenticated user instead of passing the user_id to the url.
  • Refactor the get organisation user endpoint to match the established source of truth

Expected Outcome:

  • Create organisation endpoint should match the established source of truth
    { "status_code": 201, "messge": "Organisation created", "data": { "id": "af920bf9-6443-4aaa-a5c5-5fff5e663479", "name": "string", "description": "string", "owner_id": "0b57d03b-240c-4a6c-bd6e-1d13e465113a", "email": "[email protected]", "industry": "string", "type": "string", "country": "string", "address": "string", "state": "string", "created_at": "2025-02-28T07:58:32.831Z", "updated_at": "2025-02-28T07:58:32.831Z" } }
  • An auth user should be able to get all their orgainsations using api/v1/organisation
  • The api response of the organisation user data should match the established source of truth.

Changes to be made:

  1. change the api response for organisations be refactored to fit the expected out come
  2. change the api URL and refactor the get all organisation for the auth user
  3. refactor get all users in the organisations api to match the sources of truth
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request mentor approved
Projects
None yet
Development

No branches or pull requests

2 participants