API Reference — subpackage_authors

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_authors
  description: 'API Reference — subpackage_authors. 2 operations. Lead operation: List authors. Self-contained Naftiko capability
    covering one Beehiiv business surface.'
  tags:
  - Beehiiv
  - subpackage_authors
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BEEHIIV_API_KEY: BEEHIIV_API_KEY
capability:
  consumes:
  - type: http
    namespace: beehiiv-subpackage-authors
    baseUri: https://api.beehiiv.com/v2
    description: API Reference — subpackage_authors business capability. Self-contained, no shared references.
    resources:
    - name: publications-publicationId-authors
      path: /publications/{publicationId}/authors
      operations:
      - name: index
        method: GET
        description: List authors
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: publicationId
          in: path
          type: string
          description: The prefixed ID of the publication object
          required: true
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default
            is 10.
        - name: page
          in: query
          type: integer
          description: 'Pagination returns the results in pages. Each page contains the number of results specified by the
            `limit` (default: 10).<br>If not specified, results 1-10 from'
        - name: name
          in: query
          type: string
          description: Optionally filter authors by full name or first name (case-insensitive).
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
    - name: publications-publicationId-authors-authorId
      path: /publications/{publicationId}/authors/{authorId}
      operations:
      - name: show
        method: GET
        description: Get author
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: publicationId
          in: path
          type: string
          description: The prefixed ID of the publication object
          required: true
        - name: authorId
          in: path
          type: string
          description: The author identifier. This accepts author UUID, full name, or first name.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
    authentication:
      type: bearer
      token: '{{env.BEEHIIV_API_KEY}}'
  exposes:
  - type: rest
    namespace: beehiiv-subpackage-authors-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_authors. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/publications/{publicationid}/authors
      name: publications-publicationid-authors
      description: REST surface for publications-publicationId-authors.
      operations:
      - method: GET
        name: index
        description: List authors
        call: beehiiv-subpackage-authors.index
        with:
          publicationId: rest.publicationId
          limit: rest.limit
          page: rest.page
          name: rest.name
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/publications/{publicationid}/authors/{authorid}
      name: publications-publicationid-authors-authorid
      description: REST surface for publications-publicationId-authors-authorId.
      operations:
      - method: GET
        name: show
        description: Get author
        call: beehiiv-subpackage-authors.show
        with:
          publicationId: rest.publicationId
          authorId: rest.authorId
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: beehiiv-subpackage-authors-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_authors. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-authors
      description: List authors
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: beehiiv-subpackage-authors.index
      with:
        publicationId: tools.publicationId
        limit: tools.limit
        page: tools.page
        name: tools.name
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-author
      description: Get author
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: beehiiv-subpackage-authors.show
      with:
        publicationId: tools.publicationId
        authorId: tools.authorId
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.