# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clarivate Journals API
  version: 1.0.0
extends: openapi/clarivate-journals-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/journals'].get
  update:
    x-apievangelist-phrasing:
      intent: Search JCR journals
      effect: read
      questions:
      - How do I search the Journal Citation Reports journal list?
      - Can I filter journals by impact factor quartile?
      - Which journals in a category have a JIF above a threshold?
      instructions:
      - text: Search JCR journals for {q}.
        slots:
          q: query.q
      - text: List journals in category {categoryCode} with JIF quartile {jifQuartile}.
        slots:
          categoryCode: query.categoryCode
          jifQuartile: query.jifQuartile
      - text: Find journals for JCR year {jcrYear} in edition {edition}.
        slots:
          jcrYear: query.jcrYear
          edition: query.edition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journals/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journal profile
      effect: read
      questions:
      - What publisher, ISSN and open access details are in a journal's profile?
      - Where can I find links to a journal's yearly JCR reports?
      instructions:
      - text: Get journal {id}.
        slots:
          id: path.id
      - text: Show the publisher and ISSN for journal {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journals/{id}/reports/year/{year}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journal's metrics for a JCR year
      effect: read
      questions:
      - What was a journal's Journal Impact Factor in a specific year?
      - How do I get a journal's JCR rank and influence metrics for one year?
      instructions:
      - text: Get JCR metrics for journal {id} in {year}.
        slots:
          id: path.id
          year: path.year
      - text: Show journal {id}'s impact factor and ranks for {year}.
        slots:
          id: path.id
          year: path.year
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journals/{id}/cited/year/{year}'].get
  update:
    x-apievangelist-phrasing:
      intent: List journals citing a journal in a year
      effect: read
      questions:
      - Which journals cite a given journal the most?
      - How many citations did a journal receive from each citing journal in a JCR year?
      instructions:
      - text: List journals citing journal {id} in {year}.
        slots:
          id: path.id
          year: path.year
      - text: Show page {page} of journals that cited {id} during {year}.
        slots:
          page: query.page
          id: path.id
          year: path.year
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journals/{id}/citing/year/{year}'].get
  update:
    x-apievangelist-phrasing:
      intent: List journals a journal cites in a year
      effect: read
      questions:
      - Which journals does a given journal cite most often?
      - What did a journal's articles reference in a particular JCR year?
      instructions:
      - text: List journals cited by journal {id} in {year}.
        slots:
          id: path.id
          year: path.year
      - text: Show the top {limit} journals that {id} cited in {year}.
        slots:
          limit: query.limit
          id: path.id
          year: path.year
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journals/{id}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a journal's change history
      effect: read
      questions:
      - Has a particular journal changed its title or details over time?
      - Where do I see the historical changes for one journal?
      instructions:
      - text: Get the change history of journal {id}.
        slots:
          id: path.id
      - text: Show past title and detail changes for journal {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/journals/history/title'].get
  update:
    x-apievangelist-phrasing:
      intent: List journal title changes by year
      effect: read
      questions:
      - Which journals changed their titles in a given year?
      - Can I page through all journal title changes?
      instructions:
      - text: List all journal title changes.
      - text: List journals that changed title in {changeYear}.
        slots:
          changeYear: query.changeYear
      method: generated
      generated: '2026-10-01'