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

# Judge a plan against the network's rules

> Runs the switched-ON rules guarding this plan's act over the plan and its lines, and returns EVERY verdict — passes included, because « tout est en règle » and « rien n'a tourné » are different answers and only one of them is reassuring. `blocks` are the violations that will REFUSE the validation; `warnings` are the ones that let it through and say so (three enforcement modes, not two); `skipped` are the rules that could not be measured at all, each with its reason — a rule that could not judge must never look like a rule that approved. Ask this BEFORE pressing anything: it is what keeps « Valider le plan » from being a button that fails after the fact.



## OpenAPI

````yaml /openapi.json get /v1/plans/{planId}/rules
openapi: 3.0.3
info:
  title: Solya POS API
  version: 1.0.0
  description: >-
    The Solya POS backend HTTP surface. Every documented operation is
    agent-ready: it carries an `operationId`, an agent-facing `description`, the
    `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`.
    Success responses return the payload as raw JSON; failures return the
    `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`).
servers:
  - url: /
    description: The backend, relative to its deployed origin.
security: []
paths:
  /v1/plans/{planId}/rules:
    get:
      tags:
        - Procurement
      summary: Judge a plan against the network's rules
      description: >-
        Runs the switched-ON rules guarding this plan's act over the plan and
        its lines, and returns EVERY verdict — passes included, because « tout
        est en règle » and « rien n'a tourné » are different answers and only
        one of them is reassuring. `blocks` are the violations that will REFUSE
        the validation; `warnings` are the ones that let it through and say so
        (three enforcement modes, not two); `skipped` are the rules that could
        not be measured at all, each with its reason — a rule that could not
        judge must never look like a rule that approved. Ask this BEFORE
        pressing anything: it is what keeps « Valider le plan » from being a
        button that fails after the fact.
      operationId: judgePlan
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: planId
          required: true
          description: The plan id, e.g. `plan-restock-aigle-32`.
      responses:
        '200':
          description: Every verdict, and whether the plan may proceed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  canProceed:
                    type: boolean
                  verdicts:
                    type: array
                    items: {}
                  warnings:
                    type: array
                    items: {}
                  blocks:
                    type: array
                    items: {}
                  skipped:
                    type: array
                    items: {}
                required:
                  - canProceed
                  - verdicts
                  - warnings
                  - blocks
                  - skipped
                additionalProperties: false
                description: Every verdict, and whether the plan may proceed.
                example:
                  canProceed: false
                  verdicts:
                    - ruleId: rule-plan-cap
                      ruleName: Plafond d'une commande
                      enforcementMode: BLOCK
                      violated: true
                      measured: 620000
                      threshold: 500000
                      operator: GREATER_THAN
                  warnings: []
                  blocks:
                    - ruleId: rule-plan-cap
                      ruleName: Plafond d'une commande
                      enforcementMode: BLOCK
                      violated: true
                      measured: 620000
                      threshold: 500000
                      operator: GREATER_THAN
                  skipped:
                    - ruleId: rule-shop-capacity
                      reason: not-measurable
        '400':
          description: >-
            The request failed schema validation; `error.fieldErrors` lists the
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credential was presented — send a bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The actor is authenticated but lacks the required `pos.*` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No resource matches the addressed identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error — safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: >-
        A `VALIDATION_FAILED` envelope carrying the offending fields in
        `fieldErrors`.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
            message:
              type: string
            statusCode:
              type: integer
            fieldErrors:
              type: array
              description: >-
                One entry per rejected field: the field path and why it was
                rejected.
              items:
                type: object
                required:
                  - field
                  - message
                additionalProperties: false
                properties:
                  field:
                    type: string
                    description: Dot-path of the offending field.
                  message:
                    type: string
                    description: Why the field was rejected.
    ErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: The uniform failure envelope every non-2xx response returns.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - CONFLICT
                - BUSINESS_RULE_VIOLATION
                - INTERNAL_ERROR
              description: >-
                Machine-readable kernel `ResultCode` — branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation. Safe to surface; never leaks server
                internals.
            statusCode:
              type: integer
              description: >-
                The HTTP status, mirrored into the body so a client need not
                read headers.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `Authorization: Bearer <token>`. Accepts EITHER a Keycloak access token
        (scopes-in-token) OR an opaque POS session token; both resolve to the
        same `pos.*` scope vocabulary the route guards enforce.

````