Repository navigation
README: lead with what the SDK does - #38
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Leads with a scrape request that returns markdown and HTML, followed by runnable examples for structured JSON, relevant highlights, and screenshots. Replaces every brand-lookup code sample throughout the README with scraping, including applicable async, error handling, retry, timeout, typing, and raw-response examples.
Also adds the capability table and agent integration links, and removes the Stainless attribution. Only
README.mdchanges; source code, package names, versions, and generated API references are untouched.Titles remain configured centrally in https://github.com/context-dot-dev/brand-dev-server/pull/1669. That companion PR now also configures scraping for both default and headline examples. The README examples are updated directly so these PRs show the complete scraping documentation immediately.
Validation: All 7 scraping snippets pass
php -l. Named arguments, format flags, highlights parameters, and output data fields match the SDK service and models.git diff --checkpasses. No live API requests were made.Sources checked:
src/Services/WebService.phpsrc/Web/WebScrapeParams/JsonParams.phpsrc/Web/WebScrapeResponse.phpsrc/Web/WebScrapeResponse/Markdown.phpsrc/Web/WebScrapeResponse/Json.phpsrc/Services/ParseService.phpsrc/Services/BatchService.phpsrc/Services/MonitorsService.phpsrc/Services/BrandService.phpsrc/Web/WebScrapeParams/Formats.phpsrc/Web/WebScrapeParams/HighlightsParams.phpsrc/Web/WebScrapeResponse/Highlights.phpsrc/Web/WebScrapeResponse/Screenshot.phpThis repository has no
api.md; method names were verified in its resource/service definitions.