Ryder Carrier API — Load Events

naftiko: 1.0.0-alpha2
info:
  label: Ryder Carrier API — Load Events
  description: 'Ryder Carrier API — Load Events. 5 operations. Lead operation: List Load Tenders. Self-contained Naftiko capability
    covering one Ryder System business surface.'
  tags:
  - Ryder System
  - Load Events
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RYDER_SYSTEM_API_KEY: RYDER_SYSTEM_API_KEY
capability:
  consumes:
  - type: http
    namespace: ryder-carrier-load-events
    baseUri: https://api.ryder.com/rcsc/events/v1
    description: Ryder Carrier API — Load Events business capability. Self-contained, no shared references.
    resources:
    - name: loads
      path: /loads
      operations:
      - name: listloads
        method: GET
        description: List Load Tenders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter by load status
        - name: page
          in: query
          type: integer
        - name: pageSize
          in: query
          type: integer
    - name: loads-loadId
      path: /loads/{loadId}
      operations:
      - name: getload
        method: GET
        description: Get Load Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: loadId
          in: path
          type: string
          required: true
    - name: loads-loadId-accept
      path: /loads/{loadId}/accept
      operations:
      - name: acceptload
        method: POST
        description: Accept Load Tender
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: loadId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: loads-loadId-decline
      path: /loads/{loadId}/decline
      operations:
      - name: declineload
        method: POST
        description: Decline Load Tender
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: loadId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: loads-loadId-events
      path: /loads/{loadId}/events
      operations:
      - name: createloadevent
        method: POST
        description: Submit Load Event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: loadId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: Ocp-Apim-Subscription-Key
      value: '{{env.RYDER_SYSTEM_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: ryder-carrier-load-events-rest
    port: 8080
    description: REST adapter for Ryder Carrier API — Load Events. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/loads
      name: loads
      description: REST surface for loads.
      operations:
      - method: GET
        name: listloads
        description: List Load Tenders
        call: ryder-carrier-load-events.listloads
        with:
          status: rest.status
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/loads/{loadid}
      name: loads-loadid
      description: REST surface for loads-loadId.
      operations:
      - method: GET
        name: getload
        description: Get Load Details
        call: ryder-carrier-load-events.getload
        with:
          loadId: rest.loadId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/loads/{loadid}/accept
      name: loads-loadid-accept
      description: REST surface for loads-loadId-accept.
      operations:
      - method: POST
        name: acceptload
        description: Accept Load Tender
        call: ryder-carrier-load-events.acceptload
        with:
          loadId: rest.loadId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/loads/{loadid}/decline
      name: loads-loadid-decline
      description: REST surface for loads-loadId-decline.
      operations:
      - method: POST
        name: declineload
        description: Decline Load Tender
        call: ryder-carrier-load-events.declineload
        with:
          loadId: rest.loadId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/loads/{loadid}/events
      name: loads-loadid-events
      description: REST surface for loads-loadId-events.
      operations:
      - method: POST
        name: createloadevent
        description: Submit Load Event
        call: ryder-carrier-load-events.createloadevent
        with:
          loadId: rest.loadId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ryder-carrier-load-events-mcp
    port: 9090
    transport: http
    description: MCP adapter for Ryder Carrier API — Load Events. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-load-tenders
      description: List Load Tenders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ryder-carrier-load-events.listloads
      with:
        status: tools.status
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: get-load-details
      description: Get Load Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ryder-carrier-load-events.getload
      with:
        loadId: tools.loadId
      outputParameters:
      - type: object
        mapping: $.
    - name: accept-load-tender
      description: Accept Load Tender
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ryder-carrier-load-events.acceptload
      with:
        loadId: tools.loadId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: decline-load-tender
      description: Decline Load Tender
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ryder-carrier-load-events.declineload
      with:
        loadId: tools.loadId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: submit-load-event
      description: Submit Load Event
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ryder-carrier-load-events.createloadevent
      with:
        loadId: tools.loadId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.