Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(jans-config-api): add agama flow code syntax check endpoint #3277

Closed
jgomer2001 opened this issue Dec 9, 2022 · 4 comments · Fixed by #3299
Closed

feat(jans-config-api): add agama flow code syntax check endpoint #3277

jgomer2001 opened this issue Dec 9, 2022 · 4 comments · Fixed by #3299
Assignees
Labels
comp-jans-config-api Component affected by issue or PR kind-feature Issue or PR is a new feature request

Comments

@jgomer2001
Copy link
Contributor

Add to existing agama endpoints one for syntax check. This will help expedite development in ADS avoiding successive deployment attempts

@jgomer2001 jgomer2001 self-assigned this Dec 9, 2022
@mo-auto mo-auto added comp-jans-config-api Component affected by issue or PR kind-feature Issue or PR is a new feature request labels Dec 9, 2022
@jgomer2001
Copy link
Contributor Author

@duttarnab here's how you can use the endpoint:

Endpoint /jans-config-api/api/v1/agama/syntax-check/{qname}
Purpose Determine if the text passed is valid Agama code
Method POST
Path param qname - the qualified name of the flow to analyse. Example: co.acme.MyFlow
Body The code. This payload is expected to be Content-Type: text/plain
Output A JSON object. If it contains a message property, it means the code is invalid, and the object follows this struture. This is helpful to show errors in the UI
Status Always 200

@jgomer2001
Copy link
Contributor Author

@pujavs can you add the required swagger annotations to this endpoint please?

@pujavs
Copy link
Contributor

pujavs commented Dec 20, 2022

Sure

@pujavs
Copy link
Contributor

pujavs commented Dec 20, 2022

Added spec via PR 3369

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp-jans-config-api Component affected by issue or PR kind-feature Issue or PR is a new feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants