Skip to content

Commit

Permalink
docs: remove unnecessary docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ilias Tsangaris committed Jan 4, 2022
1 parent b650bc0 commit 769739e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 21 deletions.
20 changes: 0 additions & 20 deletions packages/ruby/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,26 +25,6 @@ from the environment, or you may hardcode them.
If you're using Warden-based authentication like Devise, you may fetch the
current_user for a given request from the environment.

### Batching requests

By default, the middleware will batch requests to the ReadMe API in groups of 10.
For every 10 requests made to your application, the middleware will make a
single request to ReadMe. If you wish to override this, provide a
`buffer_length` option when configuring the middleware.

### Sensitive Data

If you have sensitive data you'd like to prevent from being sent to the Metrics
API via headers, query params or payload bodies, you can specify a list of keys
to filter via the `reject_params` option. Key-value pairs matching these keys
will not be included in the request to the Metrics API.

You are also able to specify a set of `allow_only` which should only be sent through.
Any header or body values not matching these keys will be filtered out and not
send to the API.

You may only specify either `reject_params` or `allow_only` keys, not both.

### SDK Options

Option | Type | Description
Expand Down
3 changes: 2 additions & 1 deletion packages/ruby/spec/readme/har/request_serializer_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,9 @@

request = Readme::Har::RequestSerializer.new(http_request, Readme::Filter::RejectParams.new([]))
json = request.as_json
expected = {key1: "value1", key2: "value2"}.to_json

expect(json.dig(:postData, :text)).to eq {key1: "value1", key2: "value2"}.to_json
expect(json.dig(:postData, :text)).to eq expected
end
end

Expand Down

0 comments on commit 769739e

Please sign in to comment.