Skip to content

Commit

Permalink
docs(readme): add annotation for apireferences, find_by_tag_content.
Browse files Browse the repository at this point in the history
  • Loading branch information
Rainary committed Sep 12, 2023
1 parent 680d4da commit 6b5629e
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -607,6 +607,9 @@ To find out user's status use **[GET /user/status](http://example.com/api#api-me

This mode is convenient when there's no way to determine tag ID based on the reference, for example, when ids are random strings.

> It's not recommended to use `find_by_tag_content` mode for API websites that have content with the same names.
> In that case a reference may be replaced by an incorrect link.
Let's assume that your API website code looks like this:

```html
Expand Down

0 comments on commit 6b5629e

Please sign in to comment.