context.dev 2.13.0 → 2.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b7dd8a479baecbe8b5b5a3f70afc6b36ac9a4a6fc601efaed7975f7fdd5f0f8d
4
- data.tar.gz: 24b81ca370c0fa65982b4fd6e1ef32ef8b4c9095ba26e6190848dd3551946e0f
3
+ metadata.gz: ad23a0354a5f9cc6d6ad23a499a78ebe67f48f5e8d45c2660c70f9f6582acf39
4
+ data.tar.gz: 5b20bcd0881f27b3d5033c7664233cc5638d78358979bbe5b2fd25ae1f7538fd
5
5
  SHA512:
6
- metadata.gz: a7b014eb4f206b0e8629ef80c8a7ac817ec115694666d631438a2637266cb4cb5abde270c126afab870698c78d24211feb02f1350494816c5a99939cb07b9243
7
- data.tar.gz: e2923cfd44f29539153438f72e73d7d1543bf85893731fe152afe3bdfdd1b93ea36e4407f69b7998a757c1820d9c8c8d0838539a1b14d522cec63066ea1ac26e
6
+ metadata.gz: 7ebed39d39da3add4c5177e25f778c2f1483799859ab776b9db4bb8f3f452059a5b109cee3a4df284d5c1a09abe9c5b777323673c481d9af5e2aebeebbf3b90e
7
+ data.tar.gz: 4e8e97e0881e10ea884b242681ac561cbf737dfca8b85340e3fda3718ae836b926d9ec4d7eb6d4ed5defa288b83ab432472b7af6dec8f33d59501345c9982179
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## [2.14.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.13.0...v2.14.0) (2026-09-03)
4
+
5
+
6
+ ### Features
7
+
8
+ * **sitemap:** add subdomain discovery ([5630b67](https://github.com/context-dot-dev/context-ruby-sdk/commit/5630b67ab555ab5dabd06b0ade2c4d2837f13423))
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * **openapi:** strip empty-object defaults from the generated spec ([fcbb393](https://github.com/context-dot-dev/context-ruby-sdk/commit/fcbb393067fd9058bb2d443bd2a8f2a9e4b8f17c))
14
+
3
15
  ## [2.13.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.12.0...v2.13.0) (2026-08-27)
4
16
 
5
17
 
data/README.md CHANGED
@@ -4,15 +4,6 @@ The Context Dev Ruby library provides convenient access to the Context Dev REST
4
4
 
5
5
  It is generated with [Stainless](https://www.stainless.com/).
6
6
 
7
- ## MCP Server
8
-
9
- Use the Context Dev MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
10
-
11
- [![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=context.dev-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImNvbnRleHQuZGV2LW1jcCJdLCJlbnYiOnsiQ09OVEVYVF9ERVZfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)
12
- [![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22context.dev-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22context.dev-mcp%22%5D%2C%22env%22%3A%7B%22CONTEXT_DEV_API_KEY%22%3A%22My%20API%20Key%22%7D%7D)
13
-
14
- > Note: You may need to set environment variables in your MCP client.
15
-
16
7
  ## Documentation
17
8
 
18
9
  Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/context.dev).
@@ -26,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
26
17
  <!-- x-release-please-start-version -->
27
18
 
28
19
  ```ruby
29
- gem "context.dev", "~> 2.13.0"
20
+ gem "context.dev", "~> 2.14.0"
30
21
  ```
31
22
 
32
23
  <!-- x-release-please-end -->
@@ -21,6 +21,13 @@ module ContextDev
21
21
  # @return [Hash{Symbol=>String}, nil]
22
22
  optional :headers, ContextDev::Internal::Type::HashOf[String]
23
23
 
24
+ # @!attribute include_subdomains
25
+ # When true, discover and include public pages and sitemaps on subdomains of the
26
+ # requested domain. Defaults to false.
27
+ #
28
+ # @return [Boolean, nil]
29
+ optional :include_subdomains, ContextDev::Internal::Type::Boolean
30
+
24
31
  # @!attribute max_links
25
32
  # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
26
33
  # Minimum is 1, maximum is 100,000.
@@ -75,7 +82,7 @@ module ContextDev
75
82
  # @return [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::Zdr, nil]
76
83
  optional :zdr, enum: -> { ContextDev::WebWebScrapeSitemapParams::Zdr }
77
84
 
78
- # @!method initialize(domain:, headers: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
85
+ # @!method initialize(domain:, headers: nil, include_subdomains: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
79
86
  # Some parameter documentations has been truncated, see
80
87
  # {ContextDev::Models::WebWebScrapeSitemapParams} for more details.
81
88
  #
@@ -83,6 +90,8 @@ module ContextDev
83
90
  #
84
91
  # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob
85
92
  #
93
+ # @param include_subdomains [Boolean] When true, discover and include public pages and sitemaps on subdomains of the r
94
+ #
86
95
  # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi
87
96
  #
88
97
  # @param search [String] Optional search phrase. When provided, the crawled sitemap is filtered to the pa
@@ -566,18 +566,21 @@ module ContextDev
566
566
  # Some parameter documentations has been truncated, see
567
567
  # {ContextDev::Models::WebWebScrapeSitemapParams} for more details.
568
568
  #
569
- # Crawl an entire website's sitemap and return all discovered page URLs. Pass
570
- # `search` to have the crawled sitemap filtered down to the pages about a phrase
571
- # (for example `pricing and plans` or `api authentication docs`), most relevant
572
- # first — a searched crawl scans the whole sitemap and costs 2 credits instead
573
- # of 1.
569
+ # Crawl an entire website's sitemap and return all discovered page URLs. Set
570
+ # `includeSubdomains=true` to also discover public pages and sitemaps on child
571
+ # hosts such as `docs.example.com` or `brand.example.com`. Pass `search` to have
572
+ # the discovered URLs filtered down to the pages about a phrase (for example
573
+ # `pricing and plans` or `api authentication docs`), most relevant first — a
574
+ # searched crawl scans the whole sitemap and costs 2 credits instead of 1.
574
575
  #
575
- # @overload web_scrape_sitemap(domain:, headers: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
576
+ # @overload web_scrape_sitemap(domain:, headers: nil, include_subdomains: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
576
577
  #
577
578
  # @param domain [String] Domain to build a sitemap for
578
579
  #
579
580
  # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob
580
581
  #
582
+ # @param include_subdomains [Boolean] When true, discover and include public pages and sitemaps on subdomains of the r
583
+ #
581
584
  # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi
582
585
  #
583
586
  # @param search [String] Optional search phrase. When provided, the crawled sitemap is filtered to the pa
@@ -604,6 +607,7 @@ module ContextDev
604
607
  method: :get,
605
608
  path: "web/scrape/sitemap",
606
609
  query: query.transform_keys(
610
+ include_subdomains: "includeSubdomains",
607
611
  max_links: "maxLinks",
608
612
  sitemap_url: "sitemapUrl",
609
613
  timeout_ms: "timeoutMS",
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module ContextDev
4
- VERSION = "2.13.0"
4
+ VERSION = "2.14.0"
5
5
  end
@@ -27,6 +27,14 @@ module ContextDev
27
27
  sig { params(headers: T::Hash[Symbol, String]).void }
28
28
  attr_writer :headers
29
29
 
30
+ # When true, discover and include public pages and sitemaps on subdomains of the
31
+ # requested domain. Defaults to false.
32
+ sig { returns(T.nilable(T::Boolean)) }
33
+ attr_reader :include_subdomains
34
+
35
+ sig { params(include_subdomains: T::Boolean).void }
36
+ attr_writer :include_subdomains
37
+
30
38
  # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
31
39
  # Minimum is 1, maximum is 100,000.
32
40
  sig { returns(T.nilable(Integer)) }
@@ -96,6 +104,7 @@ module ContextDev
96
104
  params(
97
105
  domain: String,
98
106
  headers: T::Hash[Symbol, String],
107
+ include_subdomains: T::Boolean,
99
108
  max_links: Integer,
100
109
  search: String,
101
110
  sitemap_url: String,
@@ -113,6 +122,9 @@ module ContextDev
113
122
  # deep-object query params such as headers[X-Custom]=value. When provided, caching
114
123
  # is bypassed: the result is neither read from nor written to cache.
115
124
  headers: nil,
125
+ # When true, discover and include public pages and sitemaps on subdomains of the
126
+ # requested domain. Defaults to false.
127
+ include_subdomains: nil,
116
128
  # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
117
129
  # Minimum is 1, maximum is 100,000.
118
130
  max_links: nil,
@@ -148,6 +160,7 @@ module ContextDev
148
160
  {
149
161
  domain: String,
150
162
  headers: T::Hash[Symbol, String],
163
+ include_subdomains: T::Boolean,
151
164
  max_links: Integer,
152
165
  search: String,
153
166
  sitemap_url: String,
@@ -729,15 +729,17 @@ module ContextDev
729
729
  )
730
730
  end
731
731
 
732
- # Crawl an entire website's sitemap and return all discovered page URLs. Pass
733
- # `search` to have the crawled sitemap filtered down to the pages about a phrase
734
- # (for example `pricing and plans` or `api authentication docs`), most relevant
735
- # first — a searched crawl scans the whole sitemap and costs 2 credits instead
736
- # of 1.
732
+ # Crawl an entire website's sitemap and return all discovered page URLs. Set
733
+ # `includeSubdomains=true` to also discover public pages and sitemaps on child
734
+ # hosts such as `docs.example.com` or `brand.example.com`. Pass `search` to have
735
+ # the discovered URLs filtered down to the pages about a phrase (for example
736
+ # `pricing and plans` or `api authentication docs`), most relevant first — a
737
+ # searched crawl scans the whole sitemap and costs 2 credits instead of 1.
737
738
  sig do
738
739
  params(
739
740
  domain: String,
740
741
  headers: T::Hash[Symbol, String],
742
+ include_subdomains: T::Boolean,
741
743
  max_links: Integer,
742
744
  search: String,
743
745
  sitemap_url: String,
@@ -755,6 +757,9 @@ module ContextDev
755
757
  # deep-object query params such as headers[X-Custom]=value. When provided, caching
756
758
  # is bypassed: the result is neither read from nor written to cache.
757
759
  headers: nil,
760
+ # When true, discover and include public pages and sitemaps on subdomains of the
761
+ # requested domain. Defaults to false.
762
+ include_subdomains: nil,
758
763
  # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
759
764
  # Minimum is 1, maximum is 100,000.
760
765
  max_links: nil,
@@ -4,6 +4,7 @@ module ContextDev
4
4
  {
5
5
  domain: String,
6
6
  headers: ::Hash[Symbol, String],
7
+ include_subdomains: bool,
7
8
  max_links: Integer,
8
9
  search: String,
9
10
  sitemap_url: String,
@@ -24,6 +25,10 @@ module ContextDev
24
25
 
25
26
  def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
26
27
 
28
+ attr_reader include_subdomains: bool?
29
+
30
+ def include_subdomains=: (bool) -> bool
31
+
27
32
  attr_reader max_links: Integer?
28
33
 
29
34
  def max_links=: (Integer) -> Integer
@@ -57,6 +62,7 @@ module ContextDev
57
62
  def initialize: (
58
63
  domain: String,
59
64
  ?headers: ::Hash[Symbol, String],
65
+ ?include_subdomains: bool,
60
66
  ?max_links: Integer,
61
67
  ?search: String,
62
68
  ?sitemap_url: String,
@@ -70,6 +76,7 @@ module ContextDev
70
76
  def to_hash: -> {
71
77
  domain: String,
72
78
  headers: ::Hash[Symbol, String],
79
+ include_subdomains: bool,
73
80
  max_links: Integer,
74
81
  search: String,
75
82
  sitemap_url: String,
@@ -164,6 +164,7 @@ module ContextDev
164
164
  def web_scrape_sitemap: (
165
165
  domain: String,
166
166
  ?headers: ::Hash[Symbol, String],
167
+ ?include_subdomains: bool,
167
168
  ?max_links: Integer,
168
169
  ?search: String,
169
170
  ?sitemap_url: String,
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: context.dev
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.13.0
4
+ version: 2.14.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Context Dev
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-08-27 00:00:00.000000000 Z
11
+ date: 2026-09-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi