[W-17756721] fix: add annotation params to prompts #6063
Conversation
@W-17756721@ add annotation params from context to prompts add process step to resolve semantically duplicate paths
| @@ -34,6 +34,7 @@ | |||
| "@stoplight/spectral-rulesets": "1.21.3", | |||
| "expand-home-dir": "0.0.3", | |||
| "find-java-home": "0.2.0", | |||
| "jsonpath-plus": "10.2.0", | |||
There was a problem hiding this comment.
a bit worried if this can be fully bundled. Will give a try
There was a problem hiding this comment.
I saw a note on the npm page regarding bundling. It mentioned that bundling for nodejs should be good, but thank you for the "trust but verify" commitment.
packages/salesforcedx-vscode-apex/src/oas/generationStrategy/methodByMethodStrategy.ts
Outdated
Show resolved
Hide resolved
| @@ -38,7 +38,7 @@ export const sourcePrompts: Prompts = { | |||
| ' Return only valid YAML output without additional explanations.\n' + | |||
| ' Ensure compliance with OpenAPI v3 validation rules:\n' + | |||
| ' - OpenAPI version must be 3.0.0.\n' + | |||
| " - Servers should always be a single '/services/apexrest' URL.\n" + | |||
| " - The OpenAPI doc servers array property MUST '/services/apexrest' URL.\n" + | |||
There was a problem hiding this comment.
I noticed that we hard-code the part in oasProcessor, so we will forever have
servers:
- url: /servers/apexrest
in OAS
is it still necessary to add the statement?
There was a problem hiding this comment.
If we remove it, then we can get some tokens back for the response 😅
There was a problem hiding this comment.
According to the guidance it is still required.
| }); | ||
| } | ||
|
|
||
| private resolvePathsThatAreSemanticallyEqual(yaml: OpenAPIV3.Document): OpenAPIV3.Document { |
There was a problem hiding this comment.
Is this step to capture what placeholders are on the path and make sure those placeholders have their corresponding parameters in path?
There was a problem hiding this comment.
If so, I think we also need to do vice versa, make sure those parameters in: path show up in the request path
There was a problem hiding this comment.
@mingxuanzhangsfdx please log a ticket for the case to make sure those parameters in: path show up in the request path.
Co-authored-by: Mingxuan Zhang <[email protected]>
modified annotation prompt builder to exclude Parameters text when no params
@W-17756721@ add annotation params from context to prompts add process step to resolve semantically duplicate paths