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

Add /choice endpoint description to README.md #29

Open
tiagostutz opened this issue Sep 24, 2020 · 5 comments
Open

Add /choice endpoint description to README.md #29

tiagostutz opened this issue Sep 24, 2020 · 5 comments
Labels

Comments

@tiagostutz
Copy link
Contributor

Following this issue comment #16 (comment), document the endpoint to get the next choice in the README.md

@viveksahu26
Copy link

Hey @tiagostutz , is this work for first time user or new contributer. Then i would like to work on it..

@tiagostutz
Copy link
Contributor Author

Hi @viveksahu26 !! Welcome to stop analyzing!
Sure, it will be really nice to have your contributions here. Just assigned the issue to you.

If you need any further assistance, please let me know!

@tiagostutz
Copy link
Contributor Author

Justo to help, you could show this returning JSON as example:

{
    "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"
                }
            ]
        }
    ]
}

@viveksahu26
Copy link

@tiagostutz , Do i need to add JSON file in readme file..

@tiagostutz
Copy link
Contributor Author

Yes, but not as an attachment, you could add the content inline, just like I did it #29 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants