Adds Get Endorsement End Point

[heyrandhir]

Date: 1 Dec 2023
Developer Name: @heyrandhir

Description:

This PR has the code changes for the APIs on the endpoint /v1/endorsements

Is Under Feature Flag

• Yes
• No

Database changes

• Yes
• No

Breaking changes (If your feature is breaking/missing something please mention pending tickets)

• Yes
• No

Is Development Tested?

• Yes
• No

Testing Stats :

Proof on local :

Since the complete response was not captured hence posting the complete response below :

GET Request to v1/endorsements/a9e48c1f-19b8-4c66-9ba2-5d8b7c80b2a6

{
    "data": {
        "createdBy": {
            "createdBy": null,
            "updatedBy": null,
            "createdAt": null,
            "updatedAt": null,
            "id": "a78a02a9-5738-406e-aa10-9ff49fdaee5a",
            "rdsUserId": "DtR9sK7CysOVHP17zl8N",
            "firstName": "Randhir",
            "lastName": "Kumar",
            "imageUrl": "https://res.cloudinary.com/realdevsquad/image/upload/v1673312957/profile/DtR9sK7CysOVHP17zl8N/bbtkpea622crqotnhsa3.jpg",
            "role": "USER",
            "skills": []
        },
        "updatedBy": {
            "createdBy": null,
            "updatedBy": null,
            "createdAt": null,
            "updatedAt": null,
            "id": "a78a02a9-5738-406e-aa10-9ff49fdaee5a",
            "rdsUserId": "DtR9sK7CysOVHP17zl8N",
            "firstName": "Randhir",
            "lastName": "Kumar",
            "imageUrl": "https://res.cloudinary.com/realdevsquad/image/upload/v1673312957/profile/DtR9sK7CysOVHP17zl8N/bbtkpea622crqotnhsa3.jpg",
            "role": "USER",
            "skills": []
        },
        "createdAt": "2023-01-15T12:30:00Z",
        "updatedAt": "2023-01-15T12:30:00Z",
        "id": "a9e48c1f-19b8-4c66-9ba2-5d8b7c80b2a6",
        "user": {
            "id": "a78a02a9-5738-406e-aa10-9ff49fdaee5a",
            "rdsUserId": "DtR9sK7CysOVHP17zl8N",
            "firstName": "Randhir",
            "lastName": "Kumar",
            "imageUrl": "https://res.cloudinary.com/realdevsquad/image/upload/v1673312957/profile/DtR9sK7CysOVHP17zl8N/bbtkpea622crqotnhsa3.jpg",
            "role": "USER",
            "skills": null
        },
        "skill": {
            "id": "a9e48c1f-19b8-4c66-9ba2-5d8b7c80b2a6",
            "type": "ATOMIC",
            "name": "Dummy Skill",
            "users": null
        },
        "status": "APPROVED",
        "endorsersList": [
            {
                "createdBy": {
                    "createdBy": null,
                    "updatedBy": null,
                    "createdAt": null,
                    "updatedAt": null,
                    "id": "a78a02a9-5738-406e-aa10-9ff49fdaee5a",
                    "rdsUserId": "DtR9sK7CysOVHP17zl8N",
                    "firstName": "Randhir",
                    "lastName": "Kumar",
                    "imageUrl": "https://res.cloudinary.com/realdevsquad/image/upload/v1673312957/profile/DtR9sK7CysOVHP17zl8N/bbtkpea622crqotnhsa3.jpg",
                    "role": "USER",
                    "skills": []
                },
                "updatedBy": {
                    "createdBy": null,
                    "updatedBy": null,
                    "createdAt": null,
                    "updatedAt": null,
                    "id": "a78a02a9-5738-406e-aa10-9ff49fdaee5a",
                    "rdsUserId": "DtR9sK7CysOVHP17zl8N",
                    "firstName": "Randhir",
                    "lastName": "Kumar",
                    "imageUrl": "https://res.cloudinary.com/realdevsquad/image/upload/v1673312957/profile/DtR9sK7CysOVHP17zl8N/bbtkpea622crqotnhsa3.jpg",
                    "role": "USER",
                    "skills": []
                },
                "createdAt": "2023-12-01T01:25:19Z",
                "updatedAt": "2023-12-01T01:25:19Z",
                "id": "7d36b769-8fe8-11ee-a493-0242ac120002",
                "endorser": {
                    "createdBy": null,
                    "updatedBy": null,
                    "createdAt": null,
                    "updatedAt": null,
                    "id": "a78a02a9-5738-406e-aa10-9ff49fdaee5a",
                    "rdsUserId": "DtR9sK7CysOVHP17zl8N",
                    "firstName": "Randhir",
                    "lastName": "Kumar",
                    "imageUrl": "https://res.cloudinary.com/realdevsquad/image/upload/v1673312957/profile/DtR9sK7CysOVHP17zl8N/bbtkpea622crqotnhsa3.jpg",
                    "role": "USER",
                    "skills": []
                },
                "description": "good in this skill",
                "deleted": false,
                "type": "POSITIVE"
            }
        ]
    },
    "message": "Data retrieved successfully"
}

[bhtibrewal]

left few comments and didn't understand why the endorserslist has a different response than the EndorsementList model

[heyrandhir]

left few comments and didn't understand why the endorserslist has a different response than the EndorsementList model

I didn't get the this part : endorserslist has a different response than the EndorsementList. you can explain here or connect over discord call sometime when free

[vikhyat187]

Hi @heyrandhir whatever dependency is there on the Auth PR, can you include those files in your PR?

[vikhyat187]

In your PR we are sending the entire Model object in the response, which shouldn't be done, we can just have the user Id or user Name, @bhtibrewal @prakashchoudhary07 @Ajeyakrishna-k what are your thoughts on this?

[heyrandhir]

Hi @heyrandhir whatever dependency is there on the Auth PR, can you include those files in your PR?

Its this entire PR #22 @vikhyat187. Without this PR, the route would encounter authentication errors. Additionally, I don't believe it's good idea to include those files in this PR, as it could be overwhelming for the reviewers to assess numerous changes within this context just for a GET route.

[heyrandhir]

In your PR we are sending the entire Model object in the response, which shouldn't be done, we can just have the user Id or user Name, @bhtibrewal @prakashchoudhary07 @Ajeyakrishna-k what are your thoughts on this?

sure lets see what others have to say, will modify accordingly

[prakashchoudhary07]

In your PR we are sending the entire Model object in the response, which shouldn't be done, we can just have the user Id or user Name, @bhtibrewal @prakashchoudhary07 @Ajeyakrishna-k what are your thoughts on this?

sure lets see what others have to say, will modify accordingly

What does the API contract say?

[vikhyat187]

In your PR we are sending the entire Model object in the response, which shouldn't be done, we can just have the user Id or user Name, @bhtibrewal @prakashchoudhary07 @Ajeyakrishna-k what are your thoughts on this?

sure lets see what others have to say, will modify accordingly

What does the API contract say?

Its the user Id as per the contracts I've written earlier @prakashchoudhary07
https://github.com/Real-Dev-Squad/skill-tree-backend/blob/develop/api-contracts.yml

cc : @heyrandhir