Skip to main content

⨠ Update introspection

The GraphQL introspection (or schema), includes data like types, fields, queries, mutations, and even the field-level descriptions.

By default, Escape will always fetch the latest introspection from your GraphQL endpoint. However, if your introspection is closed, you can still update it manually or programmatically. Escape supports the programmatic update of introspection schemas or GraphQL schemas inside the CI/CD. Using this feature, you can automatically keep your introspection schema in sync even if your introspection is closed. By uploading a GraphQL schema or an introspection response from a CI/CD environment, Escape will always be aware of your latest schema changes before a scan is started.

info

You can also manually update your application introspection on Escape.

# https://github.com/Escape-Technologies/action
name: Post Deploy
on:
push:
branches:
- staging
jobs:
Escape:
runs-on: ubuntu-latest
steps:
- name: Escape Scan
uses: Escape-Technologies/action@v0
with:
application_id: ${{ secrets.ESCAPE_APPLICATION_ID }}
api_key: ${{ secrets.ESCAPE_API_KEY }}
schema_file: relative/path/to/schema/from/repo/root/schema.graphql
// or
introspection_file: relative/path/to/schema/from/repo/root/introspection.json