Skip to content

Commit

Permalink
[RelationshiopEvaluation] Set defaults for request options
Browse files Browse the repository at this point in the history
Signed-off-by: Lee Calcote <[email protected]>
  • Loading branch information
leecalcote authored Oct 12, 2024
1 parent 9878dcc commit 289174c
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions schemas/constructs/openapi/relationshipEvaluation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,16 @@ components:
properties:
returnDiffOnly:
type: boolean
description: If true, only return the diff of changes instead of the complete updated design
description: If true, exclude the full design in the response. Instead, only include the delta between the design pre-evaluation versus post-evaluation.
default: false
enableTrace:
type: boolean
description: If true, include detailed trace information in the response
description: If true, include details of the analysis trace information in the evaluation response
default: false

EvaluationResponse:
type: object
description: Schema for the response of a relationship evaluation process in Meshery
description: "A response comprising key-value pairs, where the key corresponds to the query that triggered the evaluation. The value identifies the components and the actions the client should perform on those components. In cases of conflict where policy cannot resolve using tie-breaking strategies, the result for that specific query is empty, though the key (evaluation query) remains in the final response. Importantly, these evaluations are not recursive in nature."
required:
- schemaVersion
- design
Expand Down

0 comments on commit 289174c

Please sign in to comment.