DevArmor Integration Github API

openapi: 3.2.0
info:
  title: DevArmor Security Reviews Integration Github API
  version: 1.14.0
tags:
- name: integration-github
paths:
  /i/github/events:
    post:
      tags:
      - integration-github
      summary: Process GitHub webhook events
      operationId: github_webhook
      parameters:
      - name: x-github-event
        in: header
        required: true
        schema:
          type: string
          title: X-Github-Event
      - name: x-github-delivery
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Github-Delivery
      - name: x-github-enterprise-host
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Github-Enterprise-Host
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /i/github/events/app-installed:
    post:
      tags:
      - integration-github
      summary: Register a new GitHub app installation (to be called by frontend after GitHub…
      description: 'Called by the frontend after GitHub redirects the user back from the App installation, with the

        `installation_id`.


        The GitHub organization name is captured automatically from the `installation.created` webhook

        (see `installation_created_webhook_handler`), which stores an `unclaimed_github_installation`

        row. This endpoint claims that row and creates the `Integration`.


        If the webhook hasn''t arrived yet, a PENDING `Integration` is created with the `installation_id`;

        the webhook activates it (and fills in the org name) when it lands.'
      operationId: github_event_app_installed
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetGithubAppInstallationIDPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Github Event App Installed
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIGatewayAuth: []
  /i/github/wiki/resolve-page-url:
    post:
      tags:
      - integration-github
      summary: Resolve a pasted GitHub wiki URL to a page (to back the "paste URL" picker mode)
      operationId: resolve_github_wiki_url
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GitHubWikiResolveUrlPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitHubWikiPageSummary'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIGatewayAuth: []
components:
  schemas:
    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
    GitHubWikiResolveUrlPayload:
      properties:
        url:
          type: string
          title: Url
      type: object
      required:
      - url
      title: GitHubWikiResolveUrlPayload
    SetGithubAppInstallationIDPayload:
      properties:
        installation_id:
          type: string
          title: Installation Id
      type: object
      required:
      - installation_id
      title: SetGithubAppInstallationIDPayload
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GitHubWikiPageSummary:
      properties:
        source_id:
          type: string
          title: Source Id
        title:
          type: string
          title: Title
        owner:
          type: string
          title: Owner
        repo:
          type: string
          title: Repo
        page:
          type: string
          title: Page
        source_view_url:
          type: string
          title: Source View Url
      type: object
      required:
      - source_id
      - title
      - owner
      - repo
      - page
      - source_view_url
      title: GitHubWikiPageSummary
  securitySchemes:
    APIGatewayAuth:
      type: http
      scheme: bearer