GitHub User API — Checks

naftiko: 1.0.0-alpha2
info:
  label: GitHub User API — Checks
  description: 'GitHub User API — Checks. 3 operations. Lead operation: GitHub Check if Person is Followed by the Authenticated
    User. Self-contained Naftiko capability covering one Github business surface.'
  tags:
  - Github
  - Checks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GITHUB_API_KEY: GITHUB_API_KEY
capability:
  consumes:
  - type: http
    namespace: users-checks
    baseUri: ''
    description: GitHub User API — Checks business capability. Self-contained, no shared references.
    resources:
    - name: user-following-username
      path: /user/following/{username}
      operations:
      - name: checkifpersonisfollowedbytheauthenticateduser
        method: GET
        description: GitHub Check if Person is Followed by the Authenticated User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: user-starred-owner-repo
      path: /user/starred/{owner}/{repo}
      operations:
      - name: checkifrepositoryisstarredbytheauthenticateduser
        method: GET
        description: GitHub Check if Repository is Starred by the Authenticated User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: users-username-following-target_user
      path: /users/{username}/following/{target_user}
      operations:
      - name: checkifuserfollowsanotheruser
        method: GET
        description: GitHub Check if User Follows Another User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: target_user
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    authentication:
      type: bearer
      token: '{{env.GITHUB_API_KEY}}'
  exposes:
  - type: rest
    namespace: users-checks-rest
    port: 8080
    description: REST adapter for GitHub User API — Checks. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/user/following/{username}
      name: user-following-username
      description: REST surface for user-following-username.
      operations:
      - method: GET
        name: checkifpersonisfollowedbytheauthenticateduser
        description: GitHub Check if Person is Followed by the Authenticated User
        call: users-checks.checkifpersonisfollowedbytheauthenticateduser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user/starred/{owner}/{repo}
      name: user-starred-owner-repo
      description: REST surface for user-starred-owner-repo.
      operations:
      - method: GET
        name: checkifrepositoryisstarredbytheauthenticateduser
        description: GitHub Check if Repository is Starred by the Authenticated User
        call: users-checks.checkifrepositoryisstarredbytheauthenticateduser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{username}/following/{target-user}
      name: users-username-following-target-user
      description: REST surface for users-username-following-target_user.
      operations:
      - method: GET
        name: checkifuserfollowsanotheruser
        description: GitHub Check if User Follows Another User
        call: users-checks.checkifuserfollowsanotheruser
        with:
          target_user: rest.target_user
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: users-checks-mcp
    port: 9090
    transport: http
    description: MCP adapter for GitHub User API — Checks. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: github-check-if-person-is
      description: GitHub Check if Person is Followed by the Authenticated User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-checks.checkifpersonisfollowedbytheauthenticateduser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-check-if-repository-is
      description: GitHub Check if Repository is Starred by the Authenticated User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-checks.checkifrepositoryisstarredbytheauthenticateduser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-check-if-user-follows
      description: GitHub Check if User Follows Another User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-checks.checkifuserfollowsanotheruser
      with:
        target_user: tools.target_user
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.