Workday Compensation API — Compensation Plans

naftiko: 1.0.0-alpha2
info:
  label: Workday Compensation API — Compensation Plans
  description: 'Workday Compensation API — Compensation Plans. 3 operations. Lead operation: Get Compensation Grades. Self-contained
    Naftiko capability covering one Workday business surface.'
  tags:
  - Workday
  - Compensation Plans
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WORKDAY_API_KEY: WORKDAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: compensation-compensation-plans
    baseUri: https://wd2-impl-services1.workday.com/ccx/api/compensation/v1/{tenant}
    description: Workday Compensation API — Compensation Plans business capability. Self-contained, no shared references.
    resources:
    - name: compensationGrades
      path: /compensationGrades
      operations:
      - name: getcompensationgrades
        method: GET
        description: Get Compensation Grades
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: workers-ID-compensationPlans
      path: /workers/{ID}/compensationPlans
      operations:
      - name: getcompensationplans
        method: GET
        description: Get Compensation Plans
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: workers-ID-requestCompensationChange
      path: /workers/{ID}/requestCompensationChange
      operations:
      - name: requestcompensationchange
        method: POST
        description: Request Compensation Change
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.WORKDAY_API_KEY}}'
  exposes:
  - type: rest
    namespace: compensation-compensation-plans-rest
    port: 8080
    description: REST adapter for Workday Compensation API — Compensation Plans. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/compensationgrades
      name: compensationgrades
      description: REST surface for compensationGrades.
      operations:
      - method: GET
        name: getcompensationgrades
        description: Get Compensation Grades
        call: compensation-compensation-plans.getcompensationgrades
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workers/{id}/compensationplans
      name: workers-id-compensationplans
      description: REST surface for workers-ID-compensationPlans.
      operations:
      - method: GET
        name: getcompensationplans
        description: Get Compensation Plans
        call: compensation-compensation-plans.getcompensationplans
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workers/{id}/requestcompensationchange
      name: workers-id-requestcompensationchange
      description: REST surface for workers-ID-requestCompensationChange.
      operations:
      - method: POST
        name: requestcompensationchange
        description: Request Compensation Change
        call: compensation-compensation-plans.requestcompensationchange
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: compensation-compensation-plans-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Compensation API — Compensation Plans. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-compensation-grades
      description: Get Compensation Grades
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: compensation-compensation-plans.getcompensationgrades
      outputParameters:
      - type: object
        mapping: $.
    - name: get-compensation-plans
      description: Get Compensation Plans
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: compensation-compensation-plans.getcompensationplans
      outputParameters:
      - type: object
        mapping: $.
    - name: request-compensation-change
      description: Request Compensation Change
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: compensation-compensation-plans.requestcompensationchange
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.