[DRAFT] V2 Changelog

[geromegrignon]

WORK IN PROGRESS

All notable changes to this project for the V2 will be documented in this file.

Notice

• For documented changes, please comment on related issues
• For new changes, please open an issue

Demo

Added

[RFC] fake data

tracked by #77

add more realistic fake data

[APPROVED] add warning banner

tracked by #732

add a banner to warn about demo limitations

Changed

Fixed

Documentation

Added

[APPROVED] Hosted API Documentation

tracked with #795

hosted on Bump.sh.

Changed

[APPROVED] API Documentation auth token

tracked by #532

change to

BearerAuth: 
      type: http
      scheme: bearer
      bearerFormat: JWT 

[APPROVED] Documentation moved to Docusaurus

tracked with #720

hosted on GitHub Pages.

Fixed

Implementations

Added

Changed

[RFC] README content

tracked by #103

standardize README file

Fixed

Frontend

Added

[APPROVED] add distinct URL for tabs and pagination

tracked by #691

add proper URLs for pagination and tabs to query related data

[RFC] tag field placeholder

tracked by #628

add explicit placeholder

[RFC] 404 dedicated page

tracked by #650

specs to be defined

[RFC] search field feature

tracked with #110

missing specs so far

[APPROVED] Dedicated page to update the password

tracked with #681 #630

create a dedicated page

[APPROVED] Delete account feature

tracked with #781

create a related feature in the settings page

[RFC] favorite article

tracked with #647

allow to favorite your own articles

[RFC] Reset password feature

tracked with #419

The addition of such a feature will mostly depend on free SMTP solutions, both for the demo and the backend implementations.

Changed

[RFC] Articles pagination

tracked by #684

limit explicit pages buttons to 5

[RFC] Authentication token name

tracked by #81

change support from Bearer and/or Token to Bearer` only.

Fixed

Backend

Added

[APPROVED] Delete account feature

tracked with #781

create a related endpoint to delete an account and all related content:

• articles
• comments
• unused tags due to articles deletion

[RFC] indexed search feature

tracked with #110

missing specs so far

[RFC] Reset password feature

tracked with #419

The addition of such a feature will mostly depend on free SMTP solutions, both for the demo and the backend implementations.

[APPROVED] Dedicated endpoint to update the password

tracked with #681 #630

create a dedicated endpoint to update the password

verb: PUT
endpoint: /users/password
token required

Changed

[RFC] DELETE comment API URL

tracked by #810

change to /articles/comments/{id}

[RFC] tagList property naming

tracked by #809

change to tags

[APPROVED] POST /profiles/{username}/follow endpoint

tracked by #582

change verb to PUT

[APPROVED] GET /api/user endpoint URL

tracked by #380 #626

change URL to /api/users/me

[APPROVED] PUT /api/user endpoint URL

tracked by #380 #626

change URL to /api/users

[APPROVED] API response format abstraction

tracked with #661

change articles/user/comments... to data
change articlesCount to count

for a single item

{
  "data" : {
    "title": "Welcome to RealWorld project"
    // ...
  }
}

for multiple items

{
  "data": [
     {
        "title": "Welcome to RealWorld project"
        // ...
    }
  ],
  "count": 1
}

[RFC] API Response for POST requests

tracked by #661

change JSON response to only include the id of the newly created item.

{
  "data": {
    "id": 123456
  }
}

[RFC] API Response for PUT requests

tracked by #661

API PUT responses don't include any data.

[APPROVED] tagList format

tracked by #410

An empty list of tags must be sent as an array, not as an empty string.

[APPROVED] DELETE delete related comments and unused tags /api/articles/{slug}

tracked with #782

delete related comments and unused tags when an article is deleted

[APPROVED] favorite article endpoint /api/articles/:slug/favorite

tracked with #713

change verb to PUT

[APPROVED] follow user endpoint /api/profiles/:username/follow

tracked with #713

change verb to PUT

[APPROVED] add orderBy on tag lists retrieved with articles

tracked with #64

add orderBy desc on tag list in the response body of articles

[APPROVED] add 10 limit and orderBy popularity /api/tags

tracked with #709

limit response to the 10 more popular tags based on the number of articles using them

Fixed

[APPROVED] feed endpoint /api/articles/feed

tracked with #695

change URL to /api/feed