openapi: 3.2.0
info:
  title: Dependency Track Cwe API
  version: 1.0.0
  contact:
    name: The Dependency-Track Authors
    url: https://github.com/DependencyTrack/dependency-track
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Operations tagged cwe across 2 of this provider''s published API definitions: dependency-track-openapi-v1.yaml, dependency-track-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api
tags:
- name: cwe
paths:
  /v1/cwe:
    get:
      description: Returns a list of all CWEs
      operationId: getCwes
      parameters:
      - description: Case-insensitive substring filter matched against CWE name and CWE-ID.
        in: query
        name: searchText
        schema:
          type: string
      - description: The page to return. To be used in conjunction with <code>pageSize</code>.
        in: query
        name: pageNumber
        schema:
          type: string
          default: '1'
      - description: Number of elements to return per page. To be used in conjunction with <code>pageNumber</code>.
        in: query
        name: pageSize
        schema:
          type: string
          default: '100'
      - description: Offset to start returning elements from. To be used in conjunction with <code>limit</code>.
        in: query
        name: offset
        schema:
          type: string
      - description: Number of elements to return per page. To be used in conjunction with <code>offset</code>.
        in: query
        name: limit
        schema:
          type: string
      - description: Name of the resource field to sort on.
        in: query
        name: sortName
        schema:
          type: string
      - description: Ordering of items when sorting with <code>sortName</code>.
        in: query
        name: sortOrder
        schema:
          type: string
          enum:
          - asc, desc
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Cwe'
          description: A list of all CWEs
          headers:
            X-Total-Count:
              description: The total number of CWEs
              schema:
                format: integer
              style: simple
        '401':
          description: Unauthorized
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      tags:
      - cwe
      summary: Get cwes
      x-summary-source: derived
    servers:
    - url: /api
  /v1/cwe/{cweId}:
    get:
      operationId: getCwe
      parameters:
      - description: The CWE ID of the CWE to retrieve
        in: path
        name: cweId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cwe'
          description: A CWE matching the provided ID
        '401':
          description: Unauthorized
        '404':
          description: The CWE could not be found
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      summary: Returns a specific CWE
      tags:
      - cwe
    servers:
    - url: /api
components:
  schemas:
    Cwe:
      type: object
      properties:
        cweId:
          type: integer
          format: int32
        name:
          type: string
          pattern: ^[\p{IsWhite_Space}\p{L}\p{M}\p{S}\p{N}\p{P}]*$
  securitySchemes:
    ApiKeyAuth:
      description: Authentication via API key.
      in: header
      name: X-Api-Key
      type: apiKey
    BearerAuth:
      bearerFormat: Opaque
      description: 'Authentication via opaque server-issued session token.

        Tokens are obtained from `POST /api/v1/user/login` or

        `POST /api/v1/user/oidc/login`.'
      scheme: bearer
      type: http
x-refined-from:
- dependency-track-openapi-v1.yaml
- dependency-track-openapi.yml