> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base39.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Analyze rule document



## OpenAPI

````yaml /api-reference/openapi.json post /v2/rules/{id}/documents/{documentId}/analysis
openapi: 3.1.0
info:
  title: Base39 API
  description: Base39 API
  version: 1.0.0
  contact:
    name: Base39 Team
    url: https://base39.com.br
    email: suporte@base39.com.br
  termsOfService: https://base39.com.br/termos
  license:
    name: Proprietary
    url: https://base39.com.br/termos
servers:
  - url: http://localhost:3000
    description: Local
  - url: https://api.dev.base39.cloud
    description: Development
  - url: https://api.base39.com.br
    description: Production
security:
  - OAuth2: []
tags:
  - name: pages
    description: Profiles and reports pages
  - name: pipelines
    description: Pipeline boards (kanban) of pages
  - name: blocks
    description: Blocks operations
  - name: search
    description: Search across content
  - name: targets
    description: Lookup targets via datasets
  - name: CognitoTriggers
    description: Cognito triggers
paths:
  /v2/rules/{id}/documents/{documentId}/analysis:
    post:
      tags:
        - rules
      summary: Analyze rule document
      operationId: rule_analyze_document
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
        - name: documentId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyzeRuleDocumentInput'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleDocumentAnalysisOutput'
components:
  schemas:
    AnalyzeRuleDocumentInput:
      type: object
      properties:
        documents:
          type: array
          items:
            $ref: '#/components/schemas/RuleDocumentDraftInput'
      required:
        - documents
    RuleDocumentAnalysisOutput:
      type: object
      properties:
        problems:
          type: array
          items:
            $ref: '#/components/schemas/RuleDocumentProblemOutput'
        documentInterface:
          $ref: '#/components/schemas/RuleDocumentInterfaceOutput'
      required:
        - problems
        - documentInterface
    RuleDocumentDraftInput:
      type: object
      properties:
        documentId:
          type: string
        content:
          type: object
          additionalProperties: true
      required:
        - documentId
        - content
    RuleDocumentProblemOutput:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        blockId:
          type: string
          nullable: true
        severity:
          type: string
          enum:
            - error
            - warning
            - hint
        documentId:
          type: string
          nullable: true
        span:
          nullable: true
          type: array
          items:
            type: number
        expressionId:
          type: string
          nullable: true
      required:
        - code
        - message
        - severity
    RuleDocumentInterfaceOutput:
      type: object
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/RuleDocumentInterfaceEntityOutput'
      required:
        - entities
    RuleDocumentInterfaceEntityOutput:
      type: object
      properties:
        name:
          type: string
        kind:
          type: string
          enum:
            - input
            - output
            - model
        fields:
          type: array
          items:
            $ref: '#/components/schemas/RuleDocumentInterfaceFieldOutput'
      required:
        - name
        - kind
        - fields
    RuleDocumentInterfaceFieldOutput:
      type: object
      properties:
        name:
          type: string
        path:
          type: string
        type:
          type: string
        dataType:
          type: string
        kind:
          type: string
          enum:
            - input
            - computed
        usedBy:
          type: array
          items:
            $ref: '#/components/schemas/RuleDocumentInterfaceUsedByOutput'
        references:
          type: array
          items:
            $ref: '#/components/schemas/RuleDocumentInterfaceReferenceOutput'
      required:
        - name
        - path
        - type
        - dataType
        - kind
        - usedBy
        - references
    RuleDocumentInterfaceUsedByOutput:
      type: object
      properties:
        path:
          type: string
        type:
          type: string
        documentId:
          type: string
        blockId:
          type: string
      required:
        - path
        - type
        - documentId
        - blockId
    RuleDocumentInterfaceReferenceOutput:
      type: object
      properties:
        documentId:
          type: string
        blockId:
          type: string
        expressionId:
          type: string
        kind:
          type: string
          enum:
            - expressionRead
            - writeKey
            - dataModel
        source:
          type: string
        span:
          type: array
          items:
            type: number
      required:
        - documentId
        - blockId
        - kind
        - source
        - span
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://id.local.base39.cloud/oauth2/authorize
          tokenUrl: https://id.local.base39.cloud/oauth2/token
          scopes:
            profile: Read user profile
            email: Read user email
            openid: OpenID authentication
      description: OAuth2 Authorization Code flow

````