repowise-dev Files API

openapi: 3.2.0
info:
  title: repowise Files API
  description: REST API for repowise — codebase documentation engine
  version: 0.59.0
tags:
- name: Files
paths:
  /api/repos/{repo_id}/files:
    get:
      tags:
      - Files
      summary: Files Index
      description: 'Slim per-file rows for the browsable Files index + treemap.


        One row per indexed file node, joined in-memory from four batch reads

        (graph nodes, materialized degree metrics, health metrics, git metadata).

        Third-party and framework nodes are excluded — they share the table with

        real files but have no path to open. Percentiles for pagerank and churn are

        computed once over the full set so the client can rank without refetching.'
      operationId: files_index_api_repos__repo_id__files_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: repo_id
        in: path
        required: true
        schema:
          type: string
          title: Repo Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Files Index Api Repos  Repo Id  Files Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: internal
  /api/repos/{repo_id}/files/{file_path}:
    get:
      tags:
      - Files
      summary: File Detail
      description: Aggregate join over every per-file data source we persist.
      operationId: file_detail_api_repos__repo_id__files__file_path__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: repo_id
        in: path
        required: true
        schema:
          type: string
          title: Repo Id
      - name: file_path
        in: path
        required: true
        schema:
          type: string
          title: File Path
      - name: fields
        in: query
        required: false
        schema:
          type: string
          description: How much of each block to return. 'full' (the default) is everything. 'slim' drops the four unbounded payloads — the wiki page body, the coverage line array, per-function blame, and each finding's 'details' map — for a caller that renders the summary numbers only. 'coverage.covered_line_count' and 'function_blame_count' are present in both modes, so a caller can still tell an empty block from a dropped one.
          default: full
          title: Fields
        description: How much of each block to return. 'full' (the default) is everything. 'slim' drops the four unbounded payloads — the wiki page body, the coverage line array, per-function blame, and each finding's 'details' map — for a caller that renders the summary numbers only. 'coverage.covered_line_count' and 'function_blame_count' are present in both modes, so a caller can still tell an empty block from a dropped one.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response File Detail Api Repos  Repo Id  Files  File Path  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: internal
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
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization