DevArmor Integration Google API

openapi: 3.2.0
info:
  title: DevArmor Security Reviews Integration Google API
  version: 1.14.0
tags:
- name: integration-google
paths:
  /i/google/auth-config:
    get:
      tags:
      - integration-google
      summary: Responds with Google Drive Auth information
      description: 'Generate a Google Auth Config.

        If consent needed, after user approves, Google redirects to the **frontend** with ?code=...

        Frontend then POSTs the code to /i/google/events/app-connected.'
      operationId: google_auth_config
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleAuthConfigWithToken'
      security:
      - APIGatewayAuth: []
  /i/google/events/app-connected:
    post:
      tags:
      - integration-google
      summary: Complete Google OAuth (to be called by frontend after Google redirect)
      description: 'Exchange the authorization code from Google redirect and store tokens.


        After Google redirects the user to the frontend with ?code=..., the frontend

        calls this endpoint with the code (and optionally domain for hd verification).

        Backend exchanges code for tokens, verifies ID token, stores tokens, returns success.'
      operationId: google_events_app_connected
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleEventsAppConnectedPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleAuthConfigWithToken'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIGatewayAuth: []
  /i/google/doc/{doc_id}/design-reviews/projects:
    get:
      tags:
      - integration-google
      summary: List projects with a design review originating from a Google Doc
      operationId: list_google_doc_design_review_projects
      security:
      - APIGatewayAuth: []
      parameters:
      - name: doc_id
        in: path
        required: true
        schema:
          type: string
          title: Doc Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
                title: Response List Google Doc Design Review Projects
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /i/google/projects/{project_id}/doc/{doc_id}/design-reviews/builds/{build_type}:
    get:
      tags:
      - integration-google
      summary: Get a design review build for a Google Doc (to be called by Google Docs app)
      operationId: get_google_doc_design_review_build
      security:
      - APIGatewayAuth: []
      parameters:
      - name: doc_id
        in: path
        required: true
        schema:
          type: string
          title: Doc Id
      - name: build_type
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BuildType'
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - integration-google
      summary: Request a new design review build for a Google Doc (to be called by Google Docs…
      operationId: create_google_doc_design_review_build
      security:
      - APIGatewayAuth: []
      parameters:
      - name: doc_id
        in: path
        required: true
        schema:
          type: string
          title: Doc Id
      - name: build_type
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BuildType'
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: force
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Force
      - name: Google-Access-Token
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Google-Access-Token
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
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
    UserRole:
      type: string
      enum:
      - admin
      - customer_support
      title: UserRole
    Project:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        default:
          type: boolean
          title: Default
          default: false
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        use_memory:
          type: boolean
          title: Use Memory
          default: true
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        id:
          type: integer
          title: Id
        owner_user:
          $ref: '#/components/schemas/User'
        memory_effective:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Memory Effective
        memory_effective_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Memory Effective Reason
      type: object
      required:
      - symbolic_name
      - title
      - id
      - owner_user
      title: Project
    Build:
      properties:
        family:
          $ref: '#/components/schemas/BuildFamily'
        type:
          $ref: '#/components/schemas/BuildType'
        parameters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Parameters
        state:
          $ref: '#/components/schemas/JobState'
        eta:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Eta
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
        success:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Success
        result:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Result
        log:
          type: string
          title: Log
          default: ''
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        id:
          type: integer
          title: Id
        project:
          $ref: '#/components/schemas/Project'
        parent_id:
          type: integer
          title: Parent Id
      type: object
      required:
      - family
      - type
      - state
      - id
      - project
      - parent_id
      title: Build
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    User:
      properties:
        email:
          type: string
          title: Email
        name:
          type: string
          title: Name
        state:
          $ref: '#/components/schemas/UserState'
          default: active
        roles:
          items:
            $ref: '#/components/schemas/UserRole'
          type: array
          title: Roles
          default: []
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        id:
          type: integer
          title: Id
      type: object
      required:
      - email
      - name
      - id
      title: User
    BuildFamily:
      type: string
      enum:
      - test
      - threat_model
      - design_review
      - diagram
      - code_review
      - report
      - rule
      - data_flow_diagram
      title: BuildFamily
    JobState:
      type: string
      enum:
      - queued
      - running
      - completed
      title: JobState
    BuildType:
      type: string
      enum:
      - main
      - architecture
      - architecture_from_code
      - architecture_from_diagrams
      - architecture_from_docs
      - assumptions
      - requirements
      - findings
      - action_items
      - rules
      - pull_request_review
      - threat_model_impact
      - diagram_from_image
      - pdf
      - version_diff
      - interpretation
      title: BuildType
    GoogleAuthConfigWithToken:
      properties:
        app_id:
          type: string
          title: App Id
        client_id:
          type: string
          title: Client Id
        developer_key:
          type: string
          title: Developer Key
        access_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Access Token
        consent_needed:
          type: boolean
          title: Consent Needed
        scopes:
          items:
            type: string
          type: array
          title: Scopes
      type: object
      required:
      - app_id
      - client_id
      - developer_key
      - access_token
      - consent_needed
      - scopes
      title: GoogleAuthConfigWithToken
    GoogleEventsAppConnectedPayload:
      properties:
        code:
          type: string
          title: Code
        domain:
          anyOf:
          - type: string
          - type: 'null'
          title: Domain
      type: object
      required:
      - code
      title: GoogleEventsAppConnectedPayload
      description: Payload for POST /i/google/events/app-installed (frontend sends after Google redirect).
    UserState:
      type: string
      enum:
      - active
      - inactive
      - pending_org_approval
      title: UserState
  securitySchemes:
    APIGatewayAuth:
      type: http
      scheme: bearer