# This file is part of Dependency-Track.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# Copyright (c) OWASP Foundation. All Rights Reserved.
openapi: 3.0.3
info:
  title: OWASP Dependency-Track
  description: REST API of OWASP Dependency-Track
  version: 2.0.0
  contact:
    name: The Dependency-Track Authors
    email: dependencytrack@owasp.org
    url: https://github.com/DependencyTrack/dependency-track
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
security:
- apiKeyAuth: [ ]
- bearerAuth: [ ]
servers:
- url: /api/v2
tags:
- name: Components
  description: Endpoints related to components
- name: Extensions
  description: Endpoints related to extensions
- name: Metrics
  description: Endpoints related to metrics
- name: Projects
  description: Endpoints related to projects
- name: Teams
  description: Endpoints related to teams
- name: Workflows
  description: Endpoints related to workflows

paths:
  /components:
    $ref: "./paths/components.yaml"
  /extension-points:
    $ref: "./paths/extension-points.yaml"
  /extension-points/{extensionPointName}/extensions:
    $ref: "./paths/extension-points__name__extensions.yaml"
  /extension-points/{extensionPointName}/extensions/{extensionName}/configs:
    $ref: "./paths/extension-points__name__extensions__name__configs.yaml"
  /projects/{uuid}/components:
    $ref: "./paths/projects_uuid_components.yaml"
  /metrics/portfolio/current:
    $ref: "./paths/metrics_portfolio_current.yaml"
  /metrics/vulnerabilities:
    $ref: "./paths/metrics_vulnerabilities.yaml"
  /teams:
    $ref: "./paths/teams.yaml"
  /teams/{name}:
    $ref: "./paths/teams__name_.yaml"
  /team-memberships:
    $ref: "./paths/team-memberships.yaml"
  /workflows/{token}:
    $ref: "./paths/workflows__token__.yaml"

components:
  securitySchemes:
    apiKeyAuth:
      name: X-Api-Key
      description: Authentication via API key
      type: apiKey
      in: header
    bearerAuth:
      description: Authentication via Bearer token
      type: http
      scheme: Bearer