docs: add Tools Output Filtering reference spec#17
Open
Abdul-Moiz31 wants to merge 1 commit into
Open
Conversation
Signed-off-by: Abdulmoiz <abdulmoiz3140@gmail.com>
✅ Deploy Preview for reshaprio ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
yada
added
documentation
Member
|
Thanks, @Abdul-Moiz31, looks nice and great: please sign your PR to pass the DCO test (mandatory for review and merge). |
Author
|
Sure will do in a while |
Abdul-Moiz31
force-pushed
the
docs/tools-output-filtering
branch
from
36022e4 to
47fca9d
Compare
Author
|
@yada Thankyou !! Please check now . also i can jump into morer issue's to help shape reshaper.io Please feel free to assign me Looking forward |
Member
Do not hesitate to create issues and open discussions if you have ideas to improve the doc or find typos, issues, missing sections... Thank you. |
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
2 participants
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.
Summary
Adds the reference documentation for the Tools Output Filtering configuration schema (
ToolsFilters,apiVersion: reshapr.io/v1alpha1) scheduled for0.0.12, as tracked in reshaprio/reshapr#10.Closes #16.
What this PR adds
A new reference page at
docs/references/spec-outtools-filtering.md, wired into the References sidebar (between Custom Tools Specification and Resources Specification).The page documents:
apiVersionandkindrules, and the binding to a discovered Service viaservice.name/service.version.filters:targets an existing imported tool or a previously attached Custom Tool.retainoperation — reShapr's addition to the JSON Patch vocabulary, applied as a pre-processing step that narrows the response before patches run. Rationale, JSON Pointer semantics, ordering, and missing-path behavior are all covered.patchesoperation — the six standard JSON Patch operations (add,replace,remove,copy,move,test) with a reference table, the rules forfrom/value, ordering significance, and a pointer to RFC 6902.test, with rules on evaluation order and the "no branch matched" fallback. Mirrors the higher-level conditional construct proposed in reshapr#10.ToolsFiltersbeing driven by deployment-time concerns and the forward-lookingnameattribute that would let a Configuration Plan reference a specific filter set.Files changed
docs/references/spec-outtools-filtering.md(new)sidebars.js— adds the new doc to the References categoryMapping to issue #16 requirements
retain,patches, and Conditional filtering sectionsTest plan
npm run buildsucceeds (23 docs processed, new page included inllms.txt/llms-full.txt).../overview/why-reshapr.md,../explanations/services-and-artifacts.md,../explanations/configuration-and-exposition.md,./custom-tools-specification.md).