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

[Discrepancy]: Inconsistency in Trello REST API documentation regarding the content base URL outlook between two allowed view modes #1

Open
vitaliizghonnik opened this issue Feb 17, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@vitaliizghonnik
Copy link
Owner

vitaliizghonnik commented Feb 17, 2024

What is the discrepancy?

Trello has recently introduced a New View of the REST API documentation with a different outlook in the base URL section than it represented in the Classic View. In New View, the aside section shows the method of REST API, the endpoint is in the header, and varieties of URLs are shown in the body section. In this view, the method (GET, POST, etc.) includes the /1 (forward slash symbol and digit -1) in the URL address, which means the version of the API. In Classic View a version of API is placed beyond the method REST API.

Which version of the documentation are you using?

Version - 1

Steps to reproduce

  1. Open URL link
  2. In Classic View on the central section is POST method followed by the endpoint /1/cards/{id}/actions/comments
  3. Scroll up until a generic inline container element is at the top of the resource.
  4. On the right side at the top, click on Switch to new API view
  5. Scroll down until the heading section Add a new comment to a Card with the POST method.
  6. In New View on the right side is an aside section that is represented by the POST method followed by the endpoint /cards/{id}/actions/comments without /1

Expected result

  1. In the Classic View and the New View the method has included the same URLs.

Actual result

Attached screenshots

Classic View

Trello REST API docs - classic view

New View

Trello REST API docs - new view

What is the impact of this discrepancy?

@vitaliizghonnik vitaliizghonnik added the documentation Improvements or additions to documentation label Feb 17, 2024
@vitaliizghonnik
Copy link
Owner Author

@vitaliizghonnik vitaliizghonnik changed the title [Discrepancy]: Inconsistency in Trello REST API Documentation [Discrepancy]: Inconsistency in Trello REST API documentation regarding the content base URL outlook between two allowed view modes Feb 18, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant