Datadef API

openapi: 3.1.0
info:
  title: Datadef API
  version: '2026-11-05'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-05: 5 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Datadef has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 2
    pages-with-code: 2
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-05'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://datadef.io/guides/en/what-is-data-lineage
  - https://datadef.io/guides/en/azure-devops-repo-to-architecture-diagram
  - https://datadef.io/guides/en/how-to-implement-data-lineage
paths:
  /api/dbt/manifest:
    post:
      operationId: post_api_dbt_manifest
      tags:
      - Api
      summary: POST /api/dbt/manifest
      x-source: https://datadef.io/guides/en/how-to-implement-data-lineage
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://catalog.example.com/api/dbt/manifest  -H "Authorization: Bearer $API_KEY"  --data-binary @target/manifest.json
          3 Automate in CI/CD Add manifest upload to your dbt deployment script Best Practice: Most catalog tools (Atlan, Select Star, DataHub)
          have native dbt integrations. Use their plugins instead of building custom upload scripts. OpenLineage + Airflow Integration Setup Ste'
  /api/ingest:
    post:
      operationId: post_api_ingest
      tags:
      - Api
      summary: POST /api/ingest
      x-source: https://datadef.io/guides/en/what-is-data-lineage
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://lineage.company.com/api/ingest  -H "Content-Type: application/json"  -d @target/manifest.json 4 Phase 4:
          Add Business Context (Ongoing) Layer human knowledge onto automated lineage Metadata to Curate Ownership Assign data product owners
          to every Gold-tier asset (Slack handle, on-call rotation) Descriptions Business definitions for metrics and datasets ("What is an active
          user?'
  /api/lineage:
    post:
      operationId: post_api_lineage
      tags:
      - Api
      summary: POST /api/lineage
      x-source: https://datadef.io/guides/en/how-to-implement-data-lineage
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: python
        snippet: "requests.post(\n 'https://catalog.example.com/api/lineage',\n headers={'Authorization': f'Bearer {CATALOG_API_KEY}'},\n json=lineage_data\n\
          \ )"
  /items:
    get:
      operationId: get_items
      tags:
      - Items
      summary: GET /items?recursionLevel=Full&versionDescriptor.version=<sha>&versionDescriptor.versionType=commit
      x-source: https://datadef.io/guides/en/azure-devops-repo-to-architecture-diagram
      parameters:
      - name: recursionLevel
        in: query
        required: true
        schema:
          type: string
        description: Set to Full to retrieve the repository tree
      - name: versionDescriptor.version
        in: query
        required: true
        schema:
          type: string
        description: Commit SHA to pin the version
      - name: versionDescriptor.versionType
        in: query
        required: true
        schema:
          type: string
        description: Version type, set to commit
      - name: path
        in: query
        required: false
        schema:
          type: string
        description: Path to a specific file (used with includeContent)
      - name: includeContent
        in: query
        required: false
        schema:
          type: string
        description: When true, includes file content in the response
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /refs:
    get:
      operationId: get_refs
      tags:
      - Refs
      summary: GET /refs?filter=heads&api-version=7.1
      x-source: https://datadef.io/guides/en/azure-devops-repo-to-architecture-diagram
      parameters:
      - name: filter
        in: query
        required: true
        schema:
          type: string
        description: Filter by ref type, e.g., heads or tags
      - name: peelTags
        in: query
        required: false
        schema:
          type: string
        description: When true, annotated tags are peeled to the commit they wrap
      - name: api-version
        in: query
        required: true
        schema:
          type: string
        description: API version, pinned to 7.1
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Items
- name: Refs