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

# Record Narrative

> Record what only the controller can answer.

A new row each time rather than an update: Art. 35(11) makes review a
recurring obligation, and overwriting the previous answers would erase the
fact that the assessment used to say something else.

**Who may call it:** governance-officer or admin. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json put /v1/assessment/narrative
openapi: 3.1.0
info:
  title: RotaGrant API
  version: 0.1.0
  description: >-
    The HTTP API of a RotaGrant deployment, made from the product's own route
    definitions at the commit named in `x-rotascale-source`. Nothing here is
    written by hand.


    There is no shared endpoint. RotaGrant runs in your environment, and your
    deployment serves its own copy of this description at `/api/docs`. That copy
    is the authority on what your version has and which features are switched
    on; this one is the reference for one commit of the main line. The version
    is 0.1.0: routes and shapes can still change.


    Every route says who may call it. Most need a bearer token from the identity
    provider your deployment uses, held by a person with the role named. The
    routes an SDK calls also accept a workspace API key. A few are open, and say
    why.
servers:
  - url: https://{deployment}
    description: Your own deployment. There is no shared endpoint.
    variables:
      deployment:
        default: rotagrant.internal.example
        description: The host your deployment answers on.
security: []
paths:
  /v1/assessment/narrative:
    put:
      tags:
        - Regulatory
      summary: Record Narrative
      description: >-
        Record what only the controller can answer.


        A new row each time rather than an update: Art. 35(11) makes review a

        recurring obligation, and overwriting the previous answers would erase
        the

        fact that the assessment used to say something else.


        **Who may call it:** governance-officer or admin. A workspace API key is
        refused here: this is an act that belongs to a named person.
      operationId: record_narrative_v1_assessment_narrative_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NarrativeIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - bearerToken: []
components:
  schemas:
    NarrativeIn:
      properties:
        answers:
          additionalProperties:
            type: string
          type: object
          title: Answers
        note:
          type: string
          maxLength: 2000
          minLength: 3
          title: Note
      type: object
      required:
        - note
      title: NarrativeIn
      description: The controller's half. Everything here is theirs and stays theirs.
    AssessmentOut:
      properties:
        generated_at:
          type: string
          title: Generated At
        regime:
          anyOf:
            - $ref: '#/components/schemas/RegimeDisclosureOut'
            - type: 'null'
        sections:
          items:
            $ref: '#/components/schemas/AssessmentSectionOut'
          type: array
          title: Sections
        unanswered:
          items:
            type: string
          type: array
          title: Unanswered
        complete:
          type: boolean
          title: Complete
        safeguards_not_enforcing:
          items:
            $ref: '#/components/schemas/SafeguardOut'
          type: array
          title: Safeguards Not Enforcing
        disclaimer:
          additionalProperties: true
          type: object
          title: Disclaimer
        limit:
          type: string
          title: Limit
        reviewed_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Reviewed By
        reviewed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Reviewed At
        review_note:
          anyOf:
            - type: string
            - type: 'null'
          title: Review Note
      type: object
      required:
        - generated_at
        - sections
        - unanswered
        - complete
        - safeguards_not_enforcing
        - disclaimer
        - limit
      title: AssessmentOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RegimeDisclosureOut:
      properties:
        code:
          type: string
          title: Code
        name:
          type: string
          title: Name
        applies:
          items:
            type: string
          type: array
          title: Applies
          default: []
        resolved_from:
          type: string
          title: Resolved From
        requires_second_approver_above_minor:
          anyOf:
            - type: integer
            - type: 'null'
          title: Requires Second Approver Above Minor
        second_approver_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Second Approver Currency
        forbids:
          additionalProperties:
            type: string
          type: object
          title: Forbids
          default: {}
        assessed_against:
          type: string
          title: Assessed Against
      type: object
      required:
        - code
        - name
        - resolved_from
        - assessed_against
      title: RegimeDisclosureOut
      description: Which law an artefact was produced under, and what it required.
    AssessmentSectionOut:
      properties:
        key:
          type: string
          title: Key
        title:
          type: string
          title: Title
        article:
          type: string
          title: Article
        filled_by:
          type: string
          title: Filled By
        content:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Content
        controller_answer:
          anyOf:
            - type: string
            - type: 'null'
          title: Controller Answer
        answered:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Answered
      type: object
      required:
        - key
        - title
        - article
        - filled_by
      title: AssessmentSectionOut
    SafeguardOut:
      properties:
        key:
          type: string
          title: Key
        title:
          type: string
          title: Title
        state:
          type: string
          title: State
        detail:
          type: string
          title: Detail
        fired:
          anyOf:
            - type: integer
            - type: 'null'
          title: Fired
        to_enforce:
          anyOf:
            - type: string
            - type: 'null'
          title: To Enforce
      type: object
      required:
        - key
        - title
        - state
        - detail
      title: SafeguardOut
    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
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A token from the identity provider your deployment federates with. It
        identifies a person; their roles in the workspace decide what they may
        do.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.