Commit graph

7 commits

Author SHA1 Message Date
rhymes
1428013ebd
API: add users and videos docs (#6611) [deploy]
* Fix IDs size

* Document /api/users/{id}

* Document /users/me

* Add videos API docs
2020-03-13 09:12:09 +01:00
rhymes
4c6b901b7a
Validate API OpenAPI 3 spec (#6519)
* Add @stoplight/spectral to dev dependencies for validation

* Add yarn api-docs:lint command

* Fix linting errors

* Lower severity level

* Add ibm-openapi-validator as linter, as it inspects slightly differently
2020-03-09 16:40:05 +01:00
rhymes
f3e76e7fe5
Improve API docs for articles, add listings to it and fix bugs (#6413) [deploy]
* Fix articles index state param values

* Update Articles API docs

* Fix ClassifiedListing.cost_by_category with invalid category

* Add docs for GET|POST /listings and fix bugs

* Document PUT /api/listings/:id

* Add docs for /listings/category/{category}

* One variable down

* Improve listings update error handling
2020-03-04 15:30:02 +01:00
Jacob Herrington
7d0aeeefe5 Improve the clarity of the docs and fix Prettier config (#4899)
* Improve format and clarity of the docs [ci skip]

While this change produces a lot of git noise by enacting what seems
like an arbitrary linewrap on most of the files in the documentation it
will result in better version control and tracking of the changes in the
documentation.

For example, as it currently stands, if one was to make a
PR to move a comma in a sentence because each paragraph in most of the
files is on a single line, that small change would look in the git
history like the author had modified the entire paragraph. In reality,
this author just moved a comma.

This change also includes a significant number of modifications to the
more article-esque docs. Many of these docs were written in a sort of
stream-of-conciousness and aren't as easy to read as they could be.
Hopefully this is the first of several readability changes. If we could
get these docs to a more accessible reading level, we would probably see
an increase in contributions. :)

* Delegate markdown wrapping to Prettier

* Add linewrapping explanation in the docs [ci skip]
2019-11-26 08:40:53 -05:00
Anna Anks Nowak
c4b5530e2e Add info about bumping API version to docs.dev (#4454)
* Add views count for authenticated users articles [#4250]

* Bump API version to 0.5.6 [#4250]

* Add info about bumping API docs version requirement

* Fix Create pull request link by linking to the docs
2019-10-16 09:04:36 -04:00
Jacob Herrington
4ea1e6e020 Fix typos and mechanical mistakes (#4177) [ci skip] 2019-10-01 16:30:13 -04:00
rhymes
35526bef9b API: OpenAPI 3 spec and auto generated docs (#3650) 2019-08-12 11:36:04 -04:00