← Back to docs

On this page

Introduction

In the previous steps you made changes to your Shaip’s code and pushed it to your source repository, triggering the autodeployment of the infrastructure.

While much of this pipeline is automated, you will still need to update your data validation schema through the dashboard. This is an important part of the Shaipup infrastructure that ensures:

• your code only receives data that it can process.
• it provides others accessing your code with nuanced feedback on any erroneous data they try to pass through.
• it ensures you are only recording usage and charging people for valid requests.

Go to your Shaip in My Library

• In your MY SHAIPS tab, click the EDIT button on the Shaip you wish to update.

  

  ---

Generate a JSON schema

• Add your input variables in JSON format to the INPUT VARIABLES field.

• Click the GENERATE button to generate a JSON schema for your input variables.

  

• Once generated you can edit the schema, however the default schema be sufficient in most instances. If you need to edit the schema click the EDIT button.

• At this stage the changes won’t yet be deployed. If you leave the page your changes will be lost.

  

• Update the variables as you need.

• In the example below, a description has been added. This will be provided back to users who submit erroneous data corresponding to this field.

<aside>

❗️Important Notes:

• Be sure it remains a valid JSON schema, otherwise deployment will fail. Go to https://json-schema.org/ for more information on JSON Schemas.
• If you regenerate a schema these changes will be lost. </aside>

Deploy the revision

• Click DEPLOY REVISION to push your changes live.

  

• You will be prompted that your updating the input variable schema.

  <aside>

  ❗️Important Notes:

  • This does not update your source code.
  • Take care to make sure that this aligns with the data you expect to receive in your source code.
  • A discrepancy here will lead to unexpected behaviour. </aside>