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 Documentation for Episode endpoint #45

Closed
lelouchB opened this issue Oct 7, 2020 · 11 comments
Closed

Add Documentation for Episode endpoint #45

lelouchB opened this issue Oct 7, 2020 · 11 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request frontend good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed up-for-grabs
Projects

Comments

@lelouchB
Copy link
Owner

lelouchB commented Oct 7, 2020

The episode endpoint will be live soon..

Refer to #4 and #28 and #42

Follow this:
https://finalspaceapi.com/docs/character

@lelouchB lelouchB added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest up-for-grabs frontend labels Oct 7, 2020
@lelouchB lelouchB added this to To do in v1.0.0 Oct 7, 2020
@DmnChzl
Copy link
Contributor

DmnChzl commented Oct 7, 2020

Hi! 👋
I'd like to help, can you assign to me this issue?

@lelouchB
Copy link
Owner Author

lelouchB commented Oct 7, 2020

Sure @mrdoomy
Let me know if you have any questions.

@lelouchB lelouchB moved this from To do to In progress in v1.0.0 Oct 7, 2020
@DmnChzl
Copy link
Contributor

DmnChzl commented Oct 7, 2020

Chookity Pah! 😉

I make a draft locally, can I push my code on a new branch (and which one)?

I'd like to update this documentation with the real data structure. In fact, I'd to know what kind of array are air_date and characters: strings only? Or specific date formats? In the same way, what kind of data structure for characters: strings (again)? ids only? Or objects (like /character endpoint)? 🤔

@lelouchB
Copy link
Owner Author

lelouchB commented Oct 7, 2020

Hey @mrdoomy
you can send your PR to episode branch to the frontend/docs/episode.md

For the schema: refer to #28 and #42

Here is the data for first episode

{
        "id": 1,
        "name": "Chapter 1",
        "air_date": "02/15/2018",
        "director": "Mike Roberts",
        "writer": "Olan Rogers",
        "characters": [
            "https://finalspaceapi.com/api/v0/character/1",
            "https://finalspaceapi.com/api/v0/character/2",
            "https://finalspaceapi.com/api/v0/character/3",
            "https://finalspaceapi.com/api/v0/character/5",
            "https://finalspaceapi.com/api/v0/character/6",
            "https://finalspaceapi.com/api/v0/character/9",
            "https://finalspaceapi.com/api/v0/character/11"
        ],
        "img_url": "https://static.wikia.nocookie.net/final-space/images/9/9a/Episode_1b.jpg/revision/latest/scale-to-width-down/1000?cb=20180323215650"
    }

@DmnChzl
Copy link
Contributor

DmnChzl commented Oct 7, 2020

@lelouchB Thank you! 🙏 I'll do that.

@lelouchB lelouchB moved this from In progress to Done in v1.0.0 Oct 7, 2020
@lelouchB lelouchB closed this as completed Oct 7, 2020
@lelouchB lelouchB moved this from Done to Shipped to Production in v1.0.0 Oct 8, 2020
@lelouchB
Copy link
Owner Author

lelouchB commented Oct 8, 2020

Hey @mrdoomy
I have shipped this to production
Here is the blog for the same
https://finalspaceapi.com/docs/episode

@DmnChzl
Copy link
Contributor

DmnChzl commented Oct 8, 2020

Very nice! 👌
I ❤️ Final Space, so keep doing a good job! 😎

@lelouchB
Copy link
Owner Author

lelouchB commented Oct 8, 2020

@mrdoomy
This is the blog
https://finalspaceapi.com/blog/episode

@DmnChzl
Copy link
Contributor

DmnChzl commented Oct 8, 2020

@lelouchB
Thanks for the mention on the blog 🙏, but my hyperlink is broken:
https://github.com/MrDommy => https://github.com/MrDoomy 😅

@lelouchB
Copy link
Owner Author

lelouchB commented Oct 8, 2020

@lelouchB
Thanks for the mention on the blog 🙏, but my hyperlink is broken:
https://github.com/MrDommy => https://github.com/MrDoomy 😅
Oh
I am so sorry
I will update it just now.
Thanks for letting me know.

@lelouchB
Copy link
Owner Author

lelouchB commented Oct 8, 2020

@mrdoomy
Updated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request frontend good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed up-for-grabs
Projects
v1.0.0
Shipped to Production
Development

No branches or pull requests

2 participants