find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/repowise-dev:repowise-dev-coupling-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: repowise Coupling API
  description: REST API for repowise — codebase documentation engine
  version: 0.59.0
tags:
- name: coupling
paths:
  /api/repos/{repo_id}/coupling:
    get:
      tags:
      - coupling
      summary: Coupling
      description: 'The repo''s change-coupling graph under the filters (strongest *limit* edges).


        Co-change is a temporal hint (files committed together), not a verified

        dependency; ``strength`` is the decay-weighted count, not a percentage,

        while ``support`` is the plain number of shared commits. ``total_edges``

        and ``coupled_files`` count what the filters kept, before the cap.'
      operationId: coupling_api_repos__repo_id__coupling_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: repo_id
        in: path
        required: true
        schema:
          type: string
          title: Repo Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          default: 200
          title: Limit
      - name: area
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 1024
          - type: 'null'
          description: Only pairs with a file placed in this area.
          title: Area
        description: Only pairs with a file placed in this area.
      - name: partner
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 1024
          - type: 'null'
          description: 'With ``area``: only pairs whose other file is placed here.'
          title: Partner
        description: 'With ``area``: only pairs whose other file is placed here.'
      - name: depth
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 6
            minimum: 1
          - type: 'null'
          description: Area depth below the root; chosen when omitted.
          title: Depth
        description: Area depth below the root; chosen when omitted.
      - name: root
        in: query
        required: false
        schema:
          type: string
          maxLength: 1024
          description: Area the view is rooted at.
          default: ''
          title: Root
        description: Area the view is rooted at.
      - name: min_support
        in: query
        required: false
        schema:
          type: integer
          maximum: 10000
          minimum: 0
          description: Shared commits a pair needs.
          default: 0
          title: Min Support
        description: Shared commits a pair needs.
      - name: unexplained
        in: query
        required: false
        schema:
          type: boolean
          description: Only pairs no dependency explains.
          default: false
          title: Unexplained
        description: Only pairs no dependency explains.
      - name: cross_area
        in: query
        required: false
        schema:
          type: boolean
          description: Only pairs spanning two areas.
          default: false
          title: Cross Area
        description: Only pairs spanning two areas.
      - name: exclude_tests
        in: query
        required: false
        schema:
          type: boolean
          description: Leave out pairs touching test material.
          default: false
          title: Exclude Tests
        description: Leave out pairs touching test material.
      - name: recent_days
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 36500
            minimum: 1
          - type: 'null'
          description: Only pairs co-changed this recently, by index time.
          title: Recent Days
        description: Only pairs co-changed this recently, by index time.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CouplingGraphResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: stable
  /api/repos/{repo_id}/coupling/areas:
    get:
      tags:
      - coupling
      summary: Coupling Areas
      description: 'Which areas change together, and how many of their file pairs no

        dependency explains. Ranked by unexplained pairs, then strength.'
      operationId: coupling_areas_api_repos__repo_id__coupling_areas_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: repo_id
        in: path
        required: true
        schema:
          type: string
          title: Repo Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          description: Area pairs to return.
          default: 50
          title: Limit
        description: Area pairs to return.
      - name: top_pairs
        in: query
        required: false
        schema:
          type: integer
          maximum: 20
          minimum: 1
          description: File pairs per area pair.
          default: 5
          title: Top Pairs
        description: File pairs per area pair.
      - name: depth
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 6
            minimum: 1
          - type: 'null'
          description: Area depth below the root; chosen when omitted.
          title: Depth
        description: Area depth below the root; chosen when omitted.
      - name: root
        in: query
        required: false
        schema:
          type: string
          maxLength: 1024
          description: Area the view is rooted at.
          default: ''
          title: Root
        description: Area the view is rooted at.
      - name: min_support
        in: query
        required: false
        schema:
          type: integer
          maximum: 10000
          minimum: 0
          description: Shared commits a pair needs.
          default: 0
          title: Min Support
        description: Shared commits a pair needs.
      - name: unexplained
        in: query
        required: false
        schema:
          type: boolean
          description: Only pairs no dependency explains.
          default: false
          title: Unexplained
        description: Only pairs no dependency explains.
      - name: cross_area
        in: query
        required: false
        schema:
          type: boolean
          description: Only pairs spanning two areas.
          default: false
          title: Cross Area
        description: Only pairs spanning two areas.
      - name: exclude_tests
        in: query
        required: false
        schema:
          type: boolean
          description: Leave out pairs touching test material.
          default: false
          title: Exclude Tests
        description: Leave out pairs touching test material.
      - name: recent_days
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 36500
            minimum: 1
          - type: 'null'
          description: Only pairs co-changed this recently, by index time.
          title: Recent Days
        description: Only pairs co-changed this recently, by index time.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CouplingAreasResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: stable
components:
  schemas:
    CouplingAreaSummary:
      properties:
        pairs:
          type: integer
          title: Pairs
        unexplained_pairs:
          type: integer
          title: Unexplained Pairs
        unexplained_share:
          type: number
          title: Unexplained Share
        strength:
          type: number
          title: Strength
        co_changes:
          type: integer
          title: Co Changes
        last_co_change:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Co Change
        linked:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Linked
        hidden:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Hidden
        path:
          type: string
          title: Path
      type: object
      required:
      - pairs
      - unexplained_pairs
      - unexplained_share
      - strength
      - co_changes
      - path
      title: CouplingAreaSummary
      description: 'One area''s coupling: every kept pair with a file in it.'
    CouplingEdgeResponse:
      properties:
        source:
          type: string
          title: Source
        target:
          type: string
          title: Target
        strength:
          type: number
          title: Strength
        last_co_change:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Co Change
        support:
          type: integer
          title: Support
          default: 0
        confidence_ab:
          anyOf:
          - type: number
          - type: 'null'
          title: Confidence Ab
        confidence_ba:
          anyOf:
          - type: number
          - type: 'null'
          title: Confidence Ba
        structural:
          anyOf:
          - type: string
            enum:
            - corroborated
            - unexplained
            - not_applicable
          - type: 'null'
          title: Structural
        dependency_kind:
          anyOf:
          - type: string
          - type: 'null'
          title: Dependency Kind
        cross_area:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Cross Area
      type: object
      required:
      - source
      - target
      - strength
      title: CouplingEdgeResponse
    CouplingAreaTotals:
      properties:
        pairs:
          type: integer
          title: Pairs
        cross_area_pairs:
          type: integer
          title: Cross Area Pairs
        unexplained_pairs:
          type: integer
          title: Unexplained Pairs
        area_pairs:
          type: integer
          title: Area Pairs
        unexplained_area_pairs:
          type: integer
          title: Unexplained Area Pairs
        hidden_area_pairs:
          type: integer
          title: Hidden Area Pairs
        unlabelled_pairs:
          type: integer
          title: Unlabelled Pairs
      type: object
      required:
      - pairs
      - cross_area_pairs
      - unexplained_pairs
      - area_pairs
      - unexplained_area_pairs
      - hidden_area_pairs
      - unlabelled_pairs
      title: CouplingAreaTotals
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CouplingGraphResponse:
      properties:
        nodes:
          items:
            $ref: '#/components/schemas/CouplingNodeResponse'
          type: array
          title: Nodes
        edges:
          items:
            $ref: '#/components/schemas/CouplingEdgeResponse'
          type: array
          title: Edges
        total_edges:
          type: integer
          title: Total Edges
          default: 0
        coupled_files:
          type: integer
          title: Coupled Files
          default: 0
        total_files:
          type: integer
          title: Total Files
          default: 0
        depth:
          anyOf:
          - type: integer
          - type: 'null'
          title: Depth
      type: object
      title: CouplingGraphResponse
    CouplingNodeResponse:
      properties:
        file_path:
          type: string
          title: File Path
        module:
          anyOf:
          - type: string
          - type: 'null'
          title: Module
        score:
          anyOf:
          - type: number
          - type: 'null'
          title: Score
        nloc:
          type: integer
          title: Nloc
          default: 0
      type: object
      required:
      - file_path
      title: CouplingNodeResponse
    CouplingAreasResponse:
      properties:
        root:
          type: string
          title: Root
        depth:
          type: integer
          title: Depth
        totals:
          $ref: '#/components/schemas/CouplingAreaTotals'
        areas:
          items:
            $ref: '#/components/schemas/CouplingAreaSummary'
          type: array
          title: Areas
        area_pairs:
          items:
            $ref: '#/components/schemas/CouplingAreaPair'
          type: array
          title: Area Pairs
      type: object
      required:
      - root
      - depth
      - totals
      title: CouplingAreasResponse
    CouplingAreaPair:
      properties:
        pairs:
          type: integer
          title: Pairs
        unexplained_pairs:
          type: integer
          title: Unexplained Pairs
        unexplained_share:
          type: number
          title: Unexplained Share
        strength:
          type: number
          title: Strength
        co_changes:
          type: integer
          title: Co Changes
        last_co_change:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Co Change
        linked:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Linked
        hidden:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Hidden
        source:
          type: string
          title: Source
        target:
          type: string
          title: Target
        top_pairs:
          items:
            $ref: '#/components/schemas/CouplingEdgeResponse'
          type: array
          title: Top Pairs
      type: object
      required:
      - pairs
      - unexplained_pairs
      - unexplained_share
      - strength
      - co_changes
      - source
      - target
      title: CouplingAreaPair
      description: Two areas whose files change together; ``source == target`` for same-area pairs.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization