Port API — Scorecards

naftiko: 1.0.0-alpha2
info:
  label: Port API — Scorecards
  description: 'Port API — Scorecards. 7 operations. Lead operation: Create a scorecard. Self-contained Naftiko capability
    covering one Port business surface.'
  tags:
  - Port
  - Scorecards
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORT_API_KEY: PORT_API_KEY
capability:
  consumes:
  - type: http
    namespace: port-scorecards
    baseUri: ''
    description: Port API — Scorecards business capability. Self-contained, no shared references.
    resources:
    - name: v1-blueprints-blueprint_identifier-scorecards
      path: /v1/blueprints/{blueprint_identifier}/scorecards
      operations:
      - name: post
        method: POST
        description: Create a scorecard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: blueprint_identifier
          in: path
          type: string
          description: The identifier of the blueprint to operate on.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: put
        method: PUT
        description: Change scorecards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: blueprint_identifier
          in: path
          type: string
          description: The identifier of the blueprint to operate on.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: get
        method: GET
        description: Get a blueprint's scorecards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: blueprint_identifier
          in: path
          type: string
          description: The identifier of the blueprint to operate on.
          required: true
    - name: v1-blueprints-blueprint_identifier-scorecards-scorecard_identifier
      path: /v1/blueprints/{blueprint_identifier}/scorecards/{scorecard_identifier}
      operations:
      - name: put
        method: PUT
        description: Change a scorecard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scorecard_identifier
          in: path
          type: string
          description: The identifier of the scorecard to operate on.
          required: true
        - name: blueprint_identifier
          in: path
          type: string
          description: The identifier of the blueprint containing the scorecard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: get
        method: GET
        description: Get a scorecard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scorecard_identifier
          in: path
          type: string
          description: The identifier of the scorecard to operate on.
          required: true
        - name: blueprint_identifier
          in: path
          type: string
          description: The identifier of the blueprint containing the scorecard.
          required: true
      - name: delete
        method: DELETE
        description: Delete a scorecard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: scorecard_identifier
          in: path
          type: string
          description: The identifier of the scorecard to operate on.
          required: true
        - name: blueprint_identifier
          in: path
          type: string
          description: The identifier of the blueprint containing the scorecard.
          required: true
    - name: v1-scorecards
      path: /v1/scorecards
      operations:
      - name: get
        method: GET
        description: Get all scorecards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.PORT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: port-scorecards-rest
    port: 8080
    description: REST adapter for Port API — Scorecards. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/blueprints/{blueprint-identifier}/scorecards
      name: v1-blueprints-blueprint-identifier-scorecards
      description: REST surface for v1-blueprints-blueprint_identifier-scorecards.
      operations:
      - method: POST
        name: post
        description: Create a scorecard
        call: port-scorecards.post
        with:
          blueprint_identifier: rest.blueprint_identifier
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: Change scorecards
        call: port-scorecards.put
        with:
          blueprint_identifier: rest.blueprint_identifier
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Get a blueprint's scorecards
        call: port-scorecards.get
        with:
          blueprint_identifier: rest.blueprint_identifier
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/blueprints/{blueprint-identifier}/scorecards/{scorecard-identifier}
      name: v1-blueprints-blueprint-identifier-scorecards-scorecard-identifier
      description: REST surface for v1-blueprints-blueprint_identifier-scorecards-scorecard_identifier.
      operations:
      - method: PUT
        name: put
        description: Change a scorecard
        call: port-scorecards.put
        with:
          scorecard_identifier: rest.scorecard_identifier
          blueprint_identifier: rest.blueprint_identifier
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Get a scorecard
        call: port-scorecards.get
        with:
          scorecard_identifier: rest.scorecard_identifier
          blueprint_identifier: rest.blueprint_identifier
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete a scorecard
        call: port-scorecards.delete
        with:
          scorecard_identifier: rest.scorecard_identifier
          blueprint_identifier: rest.blueprint_identifier
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/scorecards
      name: v1-scorecards
      description: REST surface for v1-scorecards.
      operations:
      - method: GET
        name: get
        description: Get all scorecards
        call: port-scorecards.get
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: port-scorecards-mcp
    port: 9090
    transport: http
    description: MCP adapter for Port API — Scorecards. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: create-scorecard
      description: Create a scorecard
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: port-scorecards.post
      with:
        blueprint_identifier: tools.blueprint_identifier
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: change-scorecards
      description: Change scorecards
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: port-scorecards.put
      with:
        blueprint_identifier: tools.blueprint_identifier
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-blueprint-s-scorecards
      description: Get a blueprint's scorecards
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: port-scorecards.get
      with:
        blueprint_identifier: tools.blueprint_identifier
      outputParameters:
      - type: object
        mapping: $.
    - name: change-scorecard
      description: Change a scorecard
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: port-scorecards.put
      with:
        scorecard_identifier: tools.scorecard_identifier
        blueprint_identifier: tools.blueprint_identifier
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-scorecard
      description: Get a scorecard
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: port-scorecards.get
      with:
        scorecard_identifier: tools.scorecard_identifier
        blueprint_identifier: tools.blueprint_identifier
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-scorecard
      description: Delete a scorecard
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: port-scorecards.delete
      with:
        scorecard_identifier: tools.scorecard_identifier
        blueprint_identifier: tools.blueprint_identifier
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-scorecards
      description: Get all scorecards
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: port-scorecards.get
      outputParameters:
      - type: object
        mapping: $.