AnomalyArmor Public Coverage API

openapi: 3.2.0
info:
  title: Anomalyarmor Ai Public Coverage API
  version: 1.0.0
  contact:
    name: AnomalyArmor Support
    url: https://anomalyarmor.ai/support
  license:
    name: Proprietary
  description: 'Operations tagged public-coverage across 3 of this provider''s published API definitions: anomalyarmor.ai-openapi.json, app.anomalyarmor.ai-openapi.json, docs.anomalyarmor.ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:8000
  description: Development server
- url: https://api.anomalyarmor.ai
  description: Production server
tags:
- name: public-coverage
paths:
  /api/v1/sdk/coverage/company:
    get:
      tags:
      - public-coverage
      summary: Get Company Coverage
      description: 'Get company-wide coverage rollup across all assets.


        Returns average score, per-asset breakdown, tier distribution,

        and lowest-coverage assets for prioritization.


        **SDK Usage:**

        ```python

        from anomalyarmor import Client

        client = Client()

        coverage = client.coverage.company()

        print(f"Company score: {coverage.company_score}")

        ```'
      operationId: get_company_coverage_api_v1_sdk_coverage_company_get
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/sdk/coverage/{asset_id}:
    get:
      tags:
      - public-coverage
      summary: Get Asset Coverage
      description: 'Get coverage score, tier, and per-feature breakdown for an asset.


        Returns weighted score (0-100), current tier, per-feature breakdown

        with counts and percentages, and actions to reach the next tier.


        **SDK Usage:**

        ```python

        from anomalyarmor import Client

        client = Client()

        coverage = client.coverage.get("asset-uuid")

        print(f"Tier: {coverage.tier_label} (score: {coverage.score})")

        ```'
      operationId: get_asset_coverage_api_v1_sdk_coverage__asset_id__get
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/sdk/coverage/{asset_id}/gaps:
    get:
      tags:
      - public-coverage
      summary: Get Coverage Gaps
      description: 'Get prioritized monitoring gaps for an asset.


        Returns unmonitored tables ranked by importance with suggested

        monitoring types. Use POST /coverage/{asset_id}/apply to implement.


        **SDK Usage:**

        ```python

        from anomalyarmor import Client

        client = Client()

        gaps = client.coverage.gaps("asset-uuid")

        for rec in gaps.recommendations:

        print(f"{rec.table_path}: {rec.suggested_monitoring}")

        ```'
      operationId: get_coverage_gaps_api_v1_sdk_coverage__asset_id__gaps_get
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 20
          title: Limit
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/sdk/coverage/{asset_id}/apply:
    post:
      tags:
      - public-coverage
      summary: Apply Coverage Recommendations
      description: 'Apply monitoring recommendations in batch.


        Implements suggested monitoring (freshness, metrics, schema_drift)

        using existing shared operations. Returns every created resource ID

        for undo capability.


        **SDK Usage:**

        ```python

        from anomalyarmor import Client

        client = Client()

        result = client.coverage.apply("asset-uuid", types=["freshness", "metrics"])

        print(f"Applied: {len(result.applied)}, Failed: {len(result.failed)}")

        ```'
      operationId: apply_coverage_recommendations_api_v1_sdk_coverage__asset_id__apply_post
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplyRecommendationsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ApplyRecommendationsRequest:
      properties:
        types:
          items:
            type: string
            enum:
            - freshness
            - metrics
            - schema_drift
          type: array
          title: Types
          description: 'Monitoring types to apply. Empty list means apply all. Valid: freshness, metrics, schema_drift'
        table_paths:
          items:
            type: string
          type: array
          title: Table Paths
          description: Limit to specific tables. Empty means all recommended tables.
      type: object
      title: ApplyRecommendationsRequest
      description: Request to apply monitoring recommendations in batch.
    StandardResponse:
      properties:
        success:
          type: boolean
          title: Success
        data:
          anyOf:
          - {}
          - type: 'null'
          title: Data
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      required:
      - success
      title: StandardResponse
      description: Standard API response wrapper.
x-refined-from:
- anomalyarmor.ai-openapi.json
- app.anomalyarmor.ai-openapi.json
- docs.anomalyarmor.ai-openapi.json