Skip to content

Commit da82518

Browse files
committed
Added new blog entry
1 parent fb465a1 commit da82518

File tree

2 files changed

+66
-27
lines changed

2 files changed

+66
-27
lines changed

Pipfile.lock

+33-27
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
title: Add Response Samples and Descriptions for API Endpoints
2+
---
3+
categories:
4+
cc-catalog-api
5+
gsod
6+
gsod-2020
7+
open-source
8+
community
9+
---
10+
author: ariessa
11+
---
12+
series: gsod-2020-cccatalog-api-usage-guide
13+
---
14+
pub_date: 2020-10-09
15+
---
16+
body:
17+
18+
Well, hello again 👋!
19+
20+
For week 3 and week 4, I added response samples and descriptions for API endpoints. Writing documentation feels a bit like coding at this point because I need to read a lot about drf-yasg, dig through issues and questions at Github / Stackoverflow to ensure that I don’t ask redundant (or even stupid) questions.
21+
22+
### Week 3
23+
24+
I was never a fan of odd numbers and the feeling seems mutual. Week 3 was quite hectic.
25+
I moved back to my hometown during week 3. Took 3 days off to settle my stuff and set up a workspace. I worked on my GSoD project for only 2 days, Monday and Tuesday. I managed to create response samples for all API endpoints. Haven’t checked whether the documentation is being displayed as intended or not. Why? Because apparently Docker Desktop uses a lot of RAM (not this 🐏). My laptop has taken a lot of abuse throughout the years so I’m being gentle with it nowadays.
26+
27+
### Week 4
28+
29+
For this week, I reviewed what I’ve done and what I haven’t to estimate new completion time. Thank god, I have a buffer week in my GSoD timeline and deliverables. So yeah, all is good in terms of completion time. I discovered what causes the error in documentation and fixed it. I started to write descriptions for API endpoints.
30+
31+
----
32+
33+
Like the blog post? Gotta wait for 2 more weeks for another update, 😉!

0 commit comments

Comments
 (0)