skills.rest
atlanhq
atlanhqOFFICIAL
Explore all skills by this author →
Website𝕏@atlanhqGitHub

atlan-e2e-contract-validator

Generate and validate e2e_case_contract.yaml files for Atlan workflows.

4|7|Updated Apr 30, 2025
Search Tags:#testing#e2e#validation#yaml#workflows#contract#Atlan
One-click install
npx skills add https://github.com/atlanhq/atlan-sample-apps --skill atlan-e2e-contract-validator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: atlan-e2e-contract-validator
Source: https://github.com/atlanhq/atlan-sample-apps/tree/main/.agents/skills/atlan-e2e-contract-validator
Command: npx skills add https://github.com/atlanhq/atlan-sample-apps --skill atlan-e2e-contract-validator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill defines and validates end-to-end contracts for Atlan workflows, enabling teams to express expected API responses, output paths, and schema behavior in a machine-checkable form.

Core Features & Use Cases

  • Contract generation: Build e2e_case_contract.yaml from a shared template to capture test_workflow_args, server_config, expected_api_responses, expected_output_paths, and schema_assertions.
  • Contract validation: Validate contracts using the provided validator to ensure alignment with the actual workflow behavior and SDK defaults.
  • Use Case: When adding or updating workflow e2e coverage, use this skill to create and verify the e2e contract, preventing regressions and ensuring test coverage.

Quick Start

Run the shared Python validator against an e2e_case_contract.yaml file, for example: python ../_shared/scripts/validate_e2e_case_contract.py e2e_case_contract.yaml

Frequently Asked Questions about atlan-e2e-contract-validator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate end-to-end contracts for Atlan workflows?▼

End-to-end contract validation ensures your Atlan workflows behave as expected. Use the Python validator script against an e2e_case_contract.yaml file to check alignment with API responses, output paths, and schema assertions.

What should an e2e contract YAML file include for workflow testing?▼

An e2e_case_contract.yaml captures test_workflow_args, server_config, expected_api_responses, expected_output_paths, and schema_assertions. This machine-checkable form documents expected behavior and prevents regressions.

When do I need to create an e2e contract for my workflow?▼

Create or update an e2e contract when adding or modifying workflow e2e coverage. It formalizes expected outputs and API interactions, ensuring test coverage aligns with actual SDK behavior.

Can I use a shared template to build my e2e contract YAML?▼

Yes. This skill provides a shared template to construct e2e_case_contract.yaml consistently. Use it to define test arguments, configuration, and assertions before running validation.

What does the e2e contract validator check for?▼

The validator confirms your contract aligns with actual workflow API behavior and SDK defaults. It validates the structure and assertions in e2e_case_contract.yaml to catch mismatches early.

Related Skills

Explore More Software Engineering Skills→
atlanhqatlanhq
4

atlan-cli-install-configure

Install the Atlan CLI only when missing and configure tenant authentication.

Official
Advanced
gajjalaashok75-UIgajjalaashok75-UI
2

verify

Validate CLI outputs and server responses against expected results.

Community
Basic
HCMUTE-RTICHCMUTE-RTIC

api-testing-observability-api-mock

Create mock API services with FastAPI, Faker, and Pydantic.

Official
Advanced
icartshicartsh
4

api-designer

Design RESTful and GraphQL APIs with OpenAPI 3.0 specifications.

Community
Advanced