From f1158f100f213e1571ca80eefb65f370728c135f Mon Sep 17 00:00:00 2001 From: Mattias Roback Date: Wed, 21 Dec 2022 10:51:06 +0100 Subject: [PATCH 1/2] Update links in README to link to our new API documentation As the old site, developer.twingly.com, has been shut down. The documentation for all of our APIs are now available at https://app.twingly.com instead. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 97854be..3d7e008 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,8 @@ To learn more about the features of this gem, read the [gem documentation] or ch To learn more about the capabilities of Twingly's APIs, please read the [Blog Search API documentation] and [Blog LiveFeed API documentation]. [gem documentation]: https://www.rubydoc.info/github/twingly/twingly-search-api-ruby -[Blog Search API documentation]: https://developer.twingly.com/resources/search/ -[Blog LiveFeed API documentation]: https://developer.twingly.com/resources/livefeed/ +[Blog Search API documentation]: https://app.twingly.com/blog_search?tab=documentation +[Blog LiveFeed API documentation]: https://app.twingly.com/blog_livefeed?tab=documentation ### Blog Search API From 546464d4db06cf23f7294a1d0dde7ff1329fb900 Mon Sep 17 00:00:00 2001 From: Mattias Roback Date: Wed, 21 Dec 2022 11:16:19 +0100 Subject: [PATCH 2/2] Fix documentation links in the YARD documentation As the developer site has been shut down, and all documentation has moved to app.twingly.com instead. I didn't link to the specific documentation sections, just so we don't need to update the links in case we restructure the documentation in the future. --- examples/find_all_posts_mentioning_github.rb | 2 +- lib/twingly/livefeed/post.rb | 4 ++-- lib/twingly/search/post.rb | 4 ++-- lib/twingly/search/result.rb | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/find_all_posts_mentioning_github.rb b/examples/find_all_posts_mentioning_github.rb index 0495b08..25f743e 100644 --- a/examples/find_all_posts_mentioning_github.rb +++ b/examples/find_all_posts_mentioning_github.rb @@ -21,7 +21,7 @@ def initialize(keyword, language: nil) # Run block for each blog post returned from api. # Uses a sliding time-based window to get all results. - # @see https://developer.twingly.com/resources/search/#pagination + # @see https://app.twingly.com/blog_search?tab=documentation def each loop do result = execute_with_retry diff --git a/lib/twingly/livefeed/post.rb b/lib/twingly/livefeed/post.rb index 518f16a..20b1cf7 100644 --- a/lib/twingly/livefeed/post.rb +++ b/lib/twingly/livefeed/post.rb @@ -28,9 +28,9 @@ module LiveFeed # @attr_reader [String] blog_name the name of the blog # @attr_reader [String] blog_url the blog URL # @attr_reader [Integer] blog_rank the rank of the blog, based on authority and language. - # See https://developer.twingly.com/resources/ranking/#blogrank + # See https://app.twingly.com/blog_livefeed?tab=documentation # @attr_reader [Integer] authority the blog's authority/influence. - # See https://developer.twingly.com/resources/ranking/#authority + # See https://app.twingly.com/blog_livefeed?tab=documentation class Post attr_reader :id, :author, :url, :title, :text, :location_code, :language_code, :coordinates, :links, :tags, :images, :indexed_at, diff --git a/lib/twingly/search/post.rb b/lib/twingly/search/post.rb index 04365a2..cc974f2 100644 --- a/lib/twingly/search/post.rb +++ b/lib/twingly/search/post.rb @@ -27,9 +27,9 @@ module Search # @attr_reader [String] blog_name the name of the blog # @attr_reader [String] blog_url the blog URL # @attr_reader [Integer] blog_rank the rank of the blog, based on authority and language. - # See https://developer.twingly.com/resources/ranking/#blogrank + # See https://app.twingly.com/blog_search?tab=documentation # @attr_reader [Integer] authority the blog's authority/influence. - # See https://developer.twingly.com/resources/ranking/#authority + # https://app.twingly.com/blog_search?tab=documentation class Post attr_reader :id, :author, :url, :title, :text, :location_code, :language_code, :coordinates, :links, :tags, :images, :indexed_at, diff --git a/lib/twingly/search/result.rb b/lib/twingly/search/result.rb index 13063cc..8fe6337 100644 --- a/lib/twingly/search/result.rb +++ b/lib/twingly/search/result.rb @@ -20,7 +20,7 @@ class Result # within the maximum allowed query time. # @return [false] if all servers responded within the maximum allowed # query time. - # @see https://developer.twingly.com/resources/search/#response + # @see https://app.twingly.com/blog_search?tab=documentation def incomplete? @incomplete_result end