repowise-dev Meta API

openapi: 3.2.0
info:
  title: repowise Meta API
  description: REST API for repowise — codebase documentation engine
  version: 0.59.0
tags:
- name: Meta
paths:
  /api/meta/version:
    get:
      tags:
      - Meta
      summary: Get Version
      description: 'Server version + PyPI freshness, plus store status when ``repo_id`` given.


        The global version/freshness path needs no database; a session is opened

        lazily only when a ``repo_id`` is supplied (for the store-format fields).'
      operationId: get_version_api_meta_version_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: repo_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Repo Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: internal
  /api/meta/changelog:
    get:
      tags:
      - Meta
      summary: Get Changelog
      description: Return repowise's bundled changelog, newest first, capped at *limit*.
      operationId: get_changelog_api_meta_changelog_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 20
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangelogResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: internal
components:
  schemas:
    ChangelogResponse:
      properties:
        entries:
          items:
            $ref: '#/components/schemas/ChangelogEntryModel'
          type: array
          title: Entries
      type: object
      required:
      - entries
      title: ChangelogResponse
    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
    ReleaseStatsModel:
      properties:
        since:
          type: string
          title: Since
        days:
          type: integer
          title: Days
        prs:
          type: integer
          title: Prs
        contributors:
          type: integer
          title: Contributors
        first_time_contributors:
          anyOf:
          - type: integer
          - type: 'null'
          title: First Time Contributors
        files_changed:
          type: integer
          title: Files Changed
        lines_added:
          type: integer
          title: Lines Added
        lines_removed:
          type: integer
          title: Lines Removed
        types:
          $ref: '#/components/schemas/ReleaseTypeCountsModel'
        test_files_touched:
          type: integer
          title: Test Files Touched
        test_files_new:
          type: integer
          title: Test Files New
        issues_closed:
          type: integer
          title: Issues Closed
      type: object
      required:
      - since
      - days
      - prs
      - contributors
      - files_changed
      - lines_added
      - lines_removed
      - types
      - test_files_touched
      - test_files_new
      - issues_closed
      title: ReleaseStatsModel
      description: A release's "By the numbers", from ``scripts/release_stats.py``.
    VersionResponse:
      properties:
        server_version:
          type: string
          title: Server Version
        latest_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Latest Version
        update_available:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Update Available
        upgrade_command:
          type: string
          title: Upgrade Command
        store_format_version:
          anyOf:
          - type: integer
          - type: 'null'
          title: Store Format Version
        store_compatible:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Store Compatible
        reindex_recommended:
          type: boolean
          title: Reindex Recommended
          default: false
        reindex_command:
          anyOf:
          - type: string
          - type: 'null'
          title: Reindex Command
        highlights:
          items:
            $ref: '#/components/schemas/ChangelogHighlightModel'
          type: array
          title: Highlights
          default: []
        latest_highlights:
          items:
            type: string
          type: array
          title: Latest Highlights
          default: []
      type: object
      required:
      - server_version
      - upgrade_command
      title: VersionResponse
      description: Server version, PyPI freshness, and (optional) per-repo store status.
    ChangelogSectionModel:
      properties:
        name:
          type: string
          title: Name
        items:
          items:
            type: string
          type: array
          title: Items
      type: object
      required:
      - name
      - items
      title: ChangelogSectionModel
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChangelogHighlightModel:
      properties:
        id:
          type: string
          title: Id
        title:
          type: string
          title: Title
        blurb:
          type: string
          title: Blurb
        href:
          anyOf:
          - type: string
          - type: 'null'
          title: Href
      type: object
      required:
      - id
      - title
      - blurb
      title: ChangelogHighlightModel
    ReleaseTypeCountsModel:
      properties:
        fixes:
          type: integer
          title: Fixes
          default: 0
        features:
          type: integer
          title: Features
          default: 0
        perf:
          type: integer
          title: Perf
          default: 0
        refactors:
          type: integer
          title: Refactors
          default: 0
        docs:
          type: integer
          title: Docs
          default: 0
      type: object
      title: ReleaseTypeCountsModel
    ChangelogEntryModel:
      properties:
        version:
          type: string
          title: Version
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
        summary:
          type: string
          title: Summary
          default: ''
        highlights:
          items:
            $ref: '#/components/schemas/ChangelogHighlightModel'
          type: array
          title: Highlights
          default: []
        stats:
          anyOf:
          - $ref: '#/components/schemas/ReleaseStatsModel'
          - type: 'null'
        sections:
          items:
            $ref: '#/components/schemas/ChangelogSectionModel'
          type: array
          title: Sections
      type: object
      required:
      - version
      - sections
      title: ChangelogEntryModel
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization