openapi: 3.0.1
info:
  title: Anchore Enterprise Feeds
  description: Enterprise service for normalizing vulnerability data from external
    sources and making it available via API
  contact:
    email: dev@anchore.com
  license:
    name: Anchore
    url: http://www.anchore.com
  version: 3.1.0
servers:
- url: /v2
tags:
- name: Feeds
  description: Feeds Management
paths:
  /:
    get:
      description: Simple status check
      operationId: ping
      responses:
        "200":
          description: Version check response
          content: {}
      x-openapi-router-controller: anchore_enterprise.services.feeds.api.controllers.default_controller
  /health:
    get:
      description: "Health check, returns 200 and no body if service is running"
      operationId: health_check
      responses:
        "200":
          description: Empty body on success
          content: {}
      x-openapi-router-controller: anchore_enterprise.common.common
      x-anchore-authz-action: None
  /version:
    get:
      description: "Returns the version object for the service, including db schema\
        \ version info"
      operationId: version_check
      responses:
        "200":
          description: Version object describing version state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceVersion'
      x-openapi-router-controller: anchore_enterprise.common.apis
      x-anchore-authz-action: None
  /feeds:
    get:
      operationId: list_feeds
      responses:
        "200":
          description: 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedListing'
        "404":
          description: 404 NotFound
          content: {}
        "500":
          description: 500 InternalError
          content: {}
      x-openapi-router-controller: anchore_enterprise.services.feeds.api.controllers.default_controller
  /feeds/{feed}/{group}:
    get:
      operationId: get_feed_group_data
      parameters:
      - name: feed
        in: path
        required: true
        schema:
          type: string
          format: path
      - name: group
        in: path
        required: true
        schema:
          type: string
          format: path
      - name: since
        in: query
        schema:
          type: string
      - name: next_token
        in: query
        schema:
          type: string
      responses:
        "200":
          description: 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataListing'
        "404":
          description: 404 NotFound
          content: {}
        "500":
          description: 500 InternalError
          content: {}
      x-openapi-router-controller: anchore_enterprise.services.feeds.api.controllers.default_controller
  /feeds/{feed}:
    get:
      operationId: list_feed_groups
      parameters:
      - name: feed
        in: path
        required: true
        schema:
          type: string
          format: path
      responses:
        "200":
          description: 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupListing'
        "404":
          description: 404 NotFound
          content: {}
        "500":
          description: 500 InternalError
          content: {}
      x-openapi-router-controller: anchore_enterprise.services.feeds.api.controllers.default_controller
  /databases/grypedb:
    get:
      operationId: grype_db_listing
      responses:
        "200":
          description: 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrypeDBListing'
        "500":
          description: 500 InternalError
          content: {}
      x-openapi-router-controller: anchore_enterprise.services.feeds.api.controllers.default_controller
  /databases/grypedb/{name}:
    get:
      operationId: get_grype_db
      parameters:
      - name: name
        in: path
        description: the name identifier for the database
        required: true
        schema:
          type: string
          format: path
      - name: checksum
        in: query
        description: the expected checksum for the database file
        schema:
          type: string
      responses:
        "200":
          description: Grype database Gzip file
          content:
            application/x-tar:
              schema:
                type: string
                format: binary
        "404":
          description: 404 NotFound
          content: {}
        "500":
          description: 500 InternalError
          content: {}
      x-openapi-router-controller: anchore_enterprise.services.feeds.api.controllers.default_controller
  /tasks:
    get:
      operationId: get_tasks
      parameters:
      - name: filter
        in: query
        schema:
          type: string
      - name: details
        in: query
        schema:
          type: string
      responses:
        "200":
          description: 200 response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Task'
        "404":
          description: 404 NotFound
          content: {}
        "500":
          description: 500 InternalError
          content: {}
      x-openapi-router-controller: anchore_enterprise.services.feeds.api.controllers.default_controller
  /tasks/{task_id}:
    get:
      operationId: get_task
      parameters:
      - name: task_id
        in: path
        required: true
        schema:
          type: string
          format: path
      responses:
        "200":
          description: 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
        "404":
          description: 404 NotFound
          content: {}
        "500":
          description: 500 InternalError
          content: {}
      x-openapi-router-controller: anchore_enterprise.services.feeds.api.controllers.default_controller
  /system/logging:
    post:
      tags:
        - System
      summary: Change logging level for a running service
      description: Enables override of localconfig logging level until they are next rebooted
      operationId: set_new_log_level
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - logging_level
              properties:
                logging_level:
                  type: string
                  enum:
                    - default
                    - trace
                    - debug
                    - info
                    - warning
                    - error
                    - critical
      responses:
        200:
          description: Logging level successfully changed
          content:
            application/json:
              schema:
                type: object
                properties:
                  logging_level:
                    type: string
        500:
          description: Internal Error
          content: {}
      x-anchore-authz-action: updateLoggingLevel
      x-openapi-router-controller: anchore_enterprise.common.common
components:
  schemas:
    FeedListing:
      type: object
      properties:
        feeds:
          type: array
          items:
            $ref: '#/components/schemas/Feed'
        next_token:
          type: string
          description: "The token to include in subsequent requests to get the rest\
            \ of the data. If empty, this response includes all data."
      description: A collection of feed items and a 'next_token' for getting the next
        set of results
    GroupListing:
      type: object
      properties:
        groups:
          type: array
          items:
            $ref: '#/components/schemas/Group'
        next_token:
          type: string
          description: "The token to include in subsequent requests to get the rest\
            \ of the data. If empty, this response includes all data."
      description: A collection of feed items and a 'next_token' for getting the next
        set of results
    GrypeDBListing:
      type: object
      properties:
        available:
          $ref: '#/components/schemas/GrypeDBAvailabilityMap'
      description: The directory for available Grype DB versions.
    GrypeDBAvailabilityMap:
      type: object
      properties:
        "2":
          $ref: '#/components/schemas/GrypeDBList'
      additionalProperties:
        $ref: '#/components/schemas/GrypeDBList'
      description: The keys are the versions of grype for which generated DBs are
        available.
    GrypeDBList:
      type: array
      items:
        $ref: '#/components/schemas/GrypeDBMetadata'
    GrypeDBMetadata:
      type: object
      properties:
        url:
          type: string
          description: The URL to query to retrieve this DB.
        version:
          type: integer
          description: The version of Grype that the DB was generated for.
        checksum:
          type: string
          description: sha256 checksum of file contents
        built:
          type: string
          description: date on which the DB was generated
          format: date-time
      description: Group of data within a feed
    DataListing:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties: {}
        next_token:
          type: string
          description: "The token to include in subsequent requests to get the rest\
            \ of the data. If empty, this response includes all data."
      description: A collection of data items and a 'next_token' for getting the next
        set of results
    Feed:
      title: Data Feed
      type: object
      properties:
        name:
          type: string
          description: Name of the feed.
        access_tier:
          type: string
          description: The level of user allowed to access this feed's groups.
        description:
          type: string
          description: What the feed data is and means.
      description: A source of data from the anchore service composed of groups each
        with its own data series
    Group:
      title: Feed Group
      type: object
      properties:
        name:
          type: string
          description: Name of the feed group.
        access_tier:
          type: string
          description: The level of user allowed to access this group's data.
        description:
          type: string
          description: What the group data is and means.
      description: Group of data within a feed
    Task:
      type: object
      properties:
        task_id:
          type: integer
        task_type:
          type: string
        feed_id:
          type: string
        driver_id:
          type: string
        status:
          type: string
        result:
          type: object
          properties: {}
        start_time:
          type: string
        end_time:
          type: string
        started_by:
          type: string
        parent_task_id:
          type: integer
        sub_tasks:
          type: array
          items:
            $ref: '#/components/schemas/Task'
      description: A unit of work triggered either by the system or the user
    ServiceVersion:
      type: object
      properties:
        service:
          type: object
          properties:
            version:
              type: string
              description: Semantic Version string of the service implementation
        api:
          type: object
          properties:
            version:
              type: string
              description: Semantic version of the api
          description: Api Version string
        db:
          type: object
          properties:
            schema_version:
              type: string
              description: Semantic version of the db schema
        engine:
          type: object
          properties:
            version:
              type: string
              description: Version of the installed engine library
            db:
              type: string
              description: Version of the installed engine db schema
      description: Version information for a service