Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Change documentation to support API without trailing slashes#4835

Closed
anoadragon453 wants to merge 2 commits into
developfrom
anoa/trailing_slashes_docs
Closed

Change documentation to support API without trailing slashes#4835
anoadragon453 wants to merge 2 commits into
developfrom
anoa/trailing_slashes_docs

Conversation

@anoadragon453
Copy link
Copy Markdown
Member

Some documentation changes to not give people the wrong idea about having trailing slashes on their API requests.

To be paired with #4793.

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 8, 2019

Codecov Report

Merging #4835 into develop will decrease coverage by 7.65%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           develop   #4835      +/-   ##
==========================================
- Coverage    75.35%   67.7%   -7.66%     
==========================================
  Files          340     340              
  Lines        34889   34889              
  Branches      5708    5708              
==========================================
- Hits         26290   23620    -2670     
- Misses        6988    9619    +2631     
- Partials      1611    1650      +39

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 8, 2019

Codecov Report

Merging #4835 into develop will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           develop   #4835      +/-   ##
==========================================
- Coverage    75.35%   75.3%   -0.05%     
==========================================
  Files          340     340              
  Lines        34889   34943      +54     
  Branches      5708    5725      +17     
==========================================
+ Hits         26290   26315      +25     
- Misses        6988    7018      +30     
+ Partials      1611    1610       -1

Copy link
Copy Markdown
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Erm; with the exception of the one in ancient_architecture_notes.rst (which is, well, ancient), all of these endpoints will always have a slash where indicated?

For example: /_matrix/federation/v1/event is not a valid endpoint; the endpoint in question is /_matrix/federation/v1/event/{eventId}.

Also remember that ^/_matrix/federation/v1/send also matches _matrix/federation/v1/send_join/{roomId}/{eventId} and whilst it so happens that the same worker can handle both endpoints, I'm not convinced that this change is improving any clarity here.

@anoadragon453
Copy link
Copy Markdown
Member Author

anoadragon453 commented Mar 8, 2019

Ah, it just clicked in my mind that these are all regexes. There doesn't seem to be much point in this PR then.

🌵

@anoadragon453 anoadragon453 deleted the anoa/trailing_slashes_docs branch March 8, 2019 16:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants