Amazon CodeGuru Security · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Amazon CodeGuru Security

6 actions 6 updates update extends openapi/amazon-codeguru-security-openapi-original.yaml

Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-paginatedx-apievangelist-pagination-paramsx-apievangelist-slugx-apievangelist-providerx-apievangelist-categoryx-apievangelist-tagsx-authenticationx-conformance

Targets 6

$.info

$.paths['/scans'].post

$.paths['/uploadUrl'].post

$.paths['/scans'].get

$.paths['/findings/{scanName}'].get

$.paths['/metrics/findings#endDate&startDate'].get

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Amazon CodeGuru Security
  version: 1.0.0
extends: openapi/amazon-codeguru-security-openapi-original.yaml
actions:
  - target: $.info
    update:
      x-apievangelist-slug: amazon-codeguru-security
      x-apievangelist-provider: Amazon Web Services
      x-apievangelist-category: Security
      x-apievangelist-tags:
        - SAST
        - Code Analysis
        - DevSecOps
        - Developer Tools
      x-authentication: AWS Signature Version 4 (SigV4)
      x-conformance:
        - aws-sigv4
        - pagination-token
        - idempotency-client-token
  - target: $.paths['/scans'].post
    update:
      x-apievangelist-idempotent: true
      x-apievangelist-idempotency-key: clientToken
  - target: $.paths['/uploadUrl'].post
    update:
      x-apievangelist-note: Returns a pre-signed S3 URL; upload the code artifact before calling CreateScan.
  - target: $.paths['/scans'].get
    update:
      x-apievangelist-paginated: true
      x-apievangelist-pagination-params:
        - maxResults
        - nextToken
  - target: $.paths['/findings/{scanName}'].get
    update:
      x-apievangelist-paginated: true
      x-apievangelist-pagination-params:
        - maxResults
        - nextToken
  - target: $.paths['/metrics/findings#endDate&startDate'].get
    update:
      x-apievangelist-paginated: true
      x-apievangelist-pagination-params:
        - maxResults
        - nextToken