POST http://stop-analyzing/api/list-option?count=qtde

POST http://stop-analyzing/api/list-option?count=qtde

Hi @marciojunior88 !
Are you asking whether the API call will be like this?

no, I understood that it was to set up an endpoint that would be used to call the function of returning a list. Is not it?

Yes, that's it. Check this line docs in description:

curl -X POST http://localhost:8008/api/v1/choice/next?count=3 --header 'Content-Type: application/json' -d '{  "previousChoices": ["ckbh7gi0h01t60703woheadgh","ckbnvn0g143g20708xgpr101i"] }'

This is a request example. So, you will receive this data in query param and in the body. Currently, we don't have the function that will calculate what is the next option but that's not a problem now and you don't have to implement that. So, what you will do is to create the endpoint, parse the query params and the body into a struct and Println this returning 200 with an empty array.

am I supposed to write an endpoint in this complete format above?

I was thinking it was to write only the url of the endpoint as I did above

am I supposed to write an endpoint in this complete format above?

I was thinking it was to write only the url of the endpoint as I did above

Ah, now I understood your doubt....! 🤓

Yes, you should write in this complete format to preserve the semantic in the URL because this endpoint will not only list average options, it will return the next n choices the user will have to device between based on the previsou one. That's why it is "choice" and "next".
Sounds ok?

$ curl -X POST http://stop-analyzing/api/list-option?count=3 --header 'Content-Type: application/json' -d '{ "previousChoices": ["1","2","3"] }'

it is?

$ curl -X POST http://stop-analyzing/api/list-option?count=3 --header 'Content-Type: application/json' -d '{ "previousChoices": ["1","2","3"] }'

it is?

Actually, not. Please, check my comment above: #16 (comment)

$ curl -X POST http: // análise de parada / api / list-option? count = 3 --header 'Tipo de conteúdo: application / json' -d '{"previousChoices": ["1", "2" , "3"]} '
isto é?

Na verdade não. Por favor, verifique meu comentário acima: # 16 (comentário)

sorry, what's wrong?

The URL path will be /api/v1/choice/next?count=3. In your example it is /api/list-option?count=3

anything else you can contribute?

Nope, I think the only thing I had to point was the URL path.

If you have any doubt about the requirements or the code, please feel free to ask! =)

Entendido !

just passing to say that this is not restful, although it ain't a problem if you don't want it to be 😄

Yes, It would be good to have it RESTful, but that's not a problem not to have.

For example, changing this from POST to GET (as we are retrieving the next option) would make sense, but technically it would be a problem because we need to pass an array as request param and doing that is really weird. Another thing to point here is that this is not a fully transactional endpoint to the client's perspective, as he will almost have just this one endpoint to invoke. The transactional part will live in another endpoints that makes a lot of sense being RESTful (create product, retrieve product, filter product by attribute...), but they will be used in another client context, in an administration perspective.

But if you have a suggestion on how to make this endpoint RESTful it would be nice to hear you. As this issue is not done yet, there's space to change here.

GET /choice?previous=x&previous=y

This is how I would do it

But it boils down to personal preferences :P

@GreenStage I was thinking about your RESTful suggestion and I think it is better than the POST approach I suggested. Let's go for it and change the Spec to use it.

@marciojunior88, I just updated the spec in the first comment of this thread #16 (comment). please follow the new Spec for this endpoint. Quick tip:

GET /choice?previous=<previous_choice_0_id>&previous=<previous_choice_1_id>&count=<how_many_returning_choices>

• returns an array of choices based on the previous choices

Example:

$ curl -X GET http://localhost:8008/api/v1/choice?previous=ccbd7e00301a60703a3310a9&previous=ccbd7e00301a60703aedbadba&count=3

Thanks @GreenStage !

Hi @marciojunior88 !
Are you still working on this issue? If not, can we assign it to another contributor that is looking for an issue?

Thanks!

I could tackle this issue!

Awesome, @dianalin2 ! 🚀
Just assigned the issue to you. Go ahead.

If you need some help, just ask and we will come to you.

Pingback: bancodobrasil/stop-analyzing-embed#70

Hi, @tiagostutz, just for clarification, I am just writing the routing path, correct? I'm not returning anything?

Hi @dianalin2 ! Yep.!

You could return this fixed payload, just to have something returned:

{
    "completeness": "0.3",
    "choices": [
        {
            "id": "5f355a24ccb4180025ee98ab",
            "title": "Fashion Shirt",
            "subtitle": "Colored nice Shirt",
            "contentURL": "https://lorempixel.com/640/480/",
            "attributes": [
                {
                    "size": "S",
                    "color": "multiple"
                }
            ]
        },
        {
            "id": "5f358359ccb4180025ee98ad",
            "title": "Corporate Shirt",
            "subtitle": "Corporate long sleeve Shirt",
            "contentURL": "https://lorempixel.com/640/480/",
            "attributes": [
                {
                    "size": "S",
                    "color": "black"
                }
            ]
        }
    ]
}

Then, in another issue we will tackle the selecting items logic.

Hi @dianalin2
Congrats on your awesome PR!! Thanks for your contribution. I have just sent you and invite to be part of the team. I hope you can accept this and we can work on the evolution of this project. =)