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

Update the documentation #146

Open
JSYOU opened this issue Feb 17, 2023 · 0 comments
Open

Update the documentation #146

JSYOU opened this issue Feb 17, 2023 · 0 comments
Labels

Comments

@JSYOU
Copy link
Contributor

JSYOU commented Feb 17, 2023

What’s the problem you're trying to solve

With the increase of users and version updates, the current documentation is no longer sufficient to meet the user's needs and requires an update.

Describe the solution you’d like

The set-sampler section does not mention that incomplete parameter settings can cause the server to fail during the startup phase, for example, if we would like to check data from context.req.xxx like below:

-- We use the req in sql file
select  
*,  
{{ context.req.method }} as "req-method",
{{ context.req.url }} as "req-url"
from "artists" where 
ConstituentID = {{ context.params.id }}
and
{{ context.req.method }} = 'GET'
# API Schema
urlPath: /artist/:id
request:
  - fieldName: id
    fieldIn: path
    description: constituent id
    validators:
      - required
sample:
  req:
    method: GET
    url: 'localhost:3000'
  parameters:
    id: '1'
  profile: duck
profile: duck

Then we should also set the req in the sample.

Otherwise the install-vulcansql-cli section has different instructions for Windows users, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant