DevArmor Integration Atlassian API

openapi: 3.2.0
info:
  title: DevArmor Security Reviews Integration Atlassian API
  version: 1.14.0
tags:
- name: integration-atlassian
paths:
  /i/atlassian/issue/{task_name}/design-review/build/{build_type}:
    post:
      tags:
      - integration-atlassian
      summary: Request a new design review build for a Jira issue (to be called by Atlassian)
      operationId: create_atlassian_issue_design_review_build
      security:
      - APIGatewayAuth: []
      parameters:
      - name: task_name
        in: path
        required: true
        schema:
          type: string
          title: Task Name
      - name: build_type
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BuildType'
      - name: force
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Force
      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'
    get:
      tags:
      - integration-atlassian
      summary: Get a design review build for a Jira issue (to be called by Atlassian)
      operationId: get_atlassian_issue_design_review_build
      security:
      - APIGatewayAuth: []
      parameters:
      - name: task_name
        in: path
        required: true
        schema:
          type: string
          title: Task Name
      - name: build_type
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BuildType'
      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'
  /i/atlassian/events/app-installed:
    post:
      tags:
      - integration-atlassian
      summary: Register a new Atlassian app installation (to be called by Atlassian)
      operationId: notify_atlassian_event_app_installed
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Notify Atlassian Event App Installed
      security:
      - APIGatewayAuth: []
  /i/atlassian/events/app-uninstalled:
    post:
      tags:
      - integration-atlassian
      summary: Remove an Atlassian app installation (to be called by Atlassian)
      operationId: notify_atlassian_event_app_uninstalled
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Notify Atlassian Event App Uninstalled
      security:
      - APIGatewayAuth: []
  /i/atlassian/access-token:
    post:
      tags:
      - integration-atlassian
      summary: Submit Atlassian access token (to be called by Atlassian)
      operationId: submit_atlassian_access_token
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebTriggerPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIGatewayAuth: []
  /i/atlassian/events/issue-updated:
    post:
      tags:
      - integration-atlassian
      summary: Sync an updated Jira issue onto its mirrored DevArmor task (to be called by…
      operationId: notify_atlassian_event_issue_updated
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Notify Atlassian Event Issue Updated
      security:
      - APIGatewayAuth: []
  /i/atlassian/confluence/resolve-page-url:
    post:
      tags:
      - integration-atlassian
      summary: Resolve a pasted Confluence page URL to a page (to back the "paste URL" picker…
      operationId: resolve_confluence_url
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfluenceResolveUrlPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfluencePageSummary'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIGatewayAuth: []
  /i/atlassian/confluence/page-search:
    get:
      tags:
      - integration-atlassian
      summary: Search Confluence pages by title (backs type-ahead search in the picker)
      description: 'Matches pages whose title contains `q` as a substring, using the CQL `~` "contains" operator: .'
      operationId: search_confluence_pages
      security:
      - APIGatewayAuth: []
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          title: Q
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConfluencePageSummary'
                title: Response Search Confluence Pages
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /i/atlassian/tasks/search:
    get:
      tags:
      - integration-atlassian
      summary: Search Jira for issues to link (type-ahead, e.g. for the task-linking picker)
      operationId: search_atlassian_tasks
      security:
      - APIGatewayAuth: []
      parameters:
      - name: query
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          description: Card number or title text to search for
          title: Query
        description: Card number or title text to search for
      - name: namespace
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Optional Jira project key to scope results
          title: Namespace
        description: Optional Jira project key to scope results
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskSearchResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /i/atlassian/jira/project-search:
    get:
      tags:
      - integration-atlassian
      summary: Search Jira projects by key and name (backs type-ahead search in the project…
      description: 'Matches projects whose key or name contains `q`, case-insensitively, via the Jira `query` filter: . Returns at most 100 matches, ordered by project key; narrow `q` to narrow the results.'
      operationId: search_jira_projects
      security:
      - APIGatewayAuth: []
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          description: Project key or name text to search for
          title: Q
        description: Project key or name text to search for
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/JiraNamespace'
                title: Response Search Jira Projects
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /i/atlassian/jira/namespaces:
    get:
      tags:
      - integration-atlassian
      summary: List available Jira project namespaces
      description: Lists every Jira project namespace visible to the connected account, ordered by key. Supersedes the deprecated `/projects/{project_id}/tasks/{task_id}/namespaces`.
      operationId: list_jira_namespaces
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/JiraNamespace'
                type: array
                title: Response List Jira Namespaces
      security:
      - APIGatewayAuth: []
  /i/atlassian/jira/projects/{project_id_or_key}/issue-types/{issue_type_id}/custom-fields:
    get:
      tags:
      - integration-atlassian
      summary: List required custom fields with no default for a Jira project and issue type
      description: '`type` is `"string"` for free text or `{optionId: label}` for a dropdown. An unsupported required field is omitted, not refused -- see `has_unsupported_required_fields`. Standard fields are out of scope. An issue type whose create screen has more than 200 fields is refused with a 422; such an issue type cannot be pushed to.'
      operationId: get_jira_issue_type_custom_fields
      security:
      - APIGatewayAuth: []
      parameters:
      - name: project_id_or_key
        in: path
        required: true
        schema:
          type: string
          title: Project Id Or Key
      - name: issue_type_id
        in: path
        required: true
        schema:
          type: string
          title: Issue Type Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequiredFieldsResult'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /i/atlassian/confluence/scopes:
    get:
      tags:
      - integration-atlassian
      summary: Report Confluence OAuth scope status for this org
      description: Informational endpoint for the frontend. `jira_connected` is false when the org has no Atlassian integration (Jira is the required product for our Forge app, so an installed integration always has Jira); `scopes_reapproval_needed` is true when Confluence is connected but the token is missing required read scopes (prompt upgrade and re-approve). `missing_scopes` is populated only in the re-approval case.
      operationId: get_confluence_scopes
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfluenceScopesStatus'
      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
    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
    ConfluenceScopesStatus:
      properties:
        jira_connected:
          type: boolean
          title: Jira Connected
        confluence_connected:
          type: boolean
          title: Confluence Connected
        scopes_reapproval_needed:
          type: boolean
          title: Scopes Reapproval Needed
        required_scopes:
          items:
            type: string
          type: array
          title: Required Scopes
        missing_scopes:
          items:
            type: string
          type: array
          title: Missing Scopes
      type: object
      required:
      - jira_connected
      - confluence_connected
      - scopes_reapproval_needed
      - required_scopes
      - missing_scopes
      title: ConfluenceScopesStatus
    CreateMetaFieldChoice:
      properties:
        name:
          type: string
          title: Name
        title:
          type: string
          title: Title
        type:
          anyOf:
          - type: string
            const: string
          - additionalProperties:
              type: string
            type: object
          title: Type
      type: object
      required:
      - name
      - title
      - type
      title: CreateMetaFieldChoice
    UserState:
      type: string
      enum:
      - active
      - inactive
      - pending_org_approval
      title: UserState
    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
    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
    WebTriggerPayload:
      properties:
        web_triggers:
          additionalProperties:
            $ref: '#/components/schemas/WebTriggerConfig'
          type: object
          title: Web Triggers
      type: object
      required:
      - web_triggers
      title: WebTriggerPayload
    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
    RequiredFieldsResult:
      properties:
        fields:
          items:
            $ref: '#/components/schemas/CreateMetaFieldChoice'
          type: array
          title: Fields
        has_unsupported_required_fields:
          type: boolean
          title: Has Unsupported Required Fields
      type: object
      required:
      - fields
      - has_unsupported_required_fields
      title: RequiredFieldsResult
    JiraNamespace:
      properties:
        id:
          type: string
          title: Id
        namespace:
          type: string
          title: Namespace
        title:
          type: string
          title: Title
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
      type: object
      required:
      - id
      - namespace
      - title
      title: JiraNamespace
    ConfluenceResolveUrlPayload:
      properties:
        url:
          type: string
          title: Url
      type: object
      required:
      - url
      title: ConfluenceResolveUrlPayload
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WebTriggerConfig:
      properties:
        url:
          type: string
          title: Url
      type: object
      required:
      - url
      title: WebTriggerConfig
    BuildFamily:
      type: string
      enum:
      - test
      - threat_model
      - design_review
      - diagram
      - code_review
      - report
      - rule
      - data_flow_diagram
      title: BuildFamily
    UserRole:
      type: string
      enum:
      - admin
      - customer_support
      title: UserRole
    TaskSearchResponse:
      properties:
        issues:
          items:
            $ref: '#/components/schemas/JiraIssueSearchResult'
          type: array
          title: Issues
      type: object
      required:
      - issues
      title: TaskSearchResponse
    ConfluencePageSummary:
      properties:
        page_id:
          type: string
          title: Page Id
        title:
          type: string
          title: Title
        space_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Space Id
      type: object
      required:
      - page_id
      - title
      title: ConfluencePageSummary
    JobState:
      type: string
      enum:
      - queued
      - running
      - completed
      title: JobState
    JiraIssueSearchResult:
      properties:
        ext_task_id:
          type: string
          title: Ext Task Id
        ext_task_key:
          type: string
          title: Ext Task Key
        title:
          type: string
          title: Title
        source_view_url:
          type: string
          title: Source View Url
      type: object
      required:
      - ext_task_id
      - ext_task_key
      - title
      - source_view_url
      title: JiraIssueSearchResult
  securitySchemes:
    APIGatewayAuth:
      type: http
      scheme: bearer