Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Newsshield API

12 actions 12 updates phrasing extends openapi/thehiveryiq-com-newsshield-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hive Civilization's API. It is a proposal applied on top of the contract, not a document Hive Civilization publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 12

$.info
$.paths['/v1/newsshield/health'].get
$.paths['/v1/newsshield/pricing'].get
$.paths['/v1/newsshield/capture/attest'].post
$.paths['/v1/newsshield/edit/attest'].post
$.paths['/v1/newsshield/publish/attest'].post
$.paths['/v1/newsshield/syndicate/attest'].post
$.paths['/v1/newsshield/takedown/attest'].post
$.paths['/v1/newsshield/asset/{asset_id}'].get
$.paths['/v1/newsshield/asset/verify'].post
$.paths['/v1/newsshield/chain/verify'].post
$.paths['/v1/newsshield/by-publisher/{publisher_did}'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Thehiveryiq Com Newsshield API
  version: 1.0.0
extends: openapi/thehiveryiq-com-newsshield-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/v1/newsshield/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check NewsShield service health
      effect: read
      questions:
      - Is the NewsShield media provenance service up?
      - Can I run a quick liveness check on NewsShield?
      instructions:
      - text: Check NewsShield health.
      - text: Confirm NewsShield is responding before I attest media.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsshield/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: View NewsShield pricing
      effect: read
      questions:
      - What does NewsShield charge for media lifecycle attestations?
      - Where is the NewsShield price list?
      instructions:
      - text: Show NewsShield pricing.
      - text: Get the NewsShield price list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsshield/capture/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest a media capture event
      effect: write
      questions:
      - How do I prove a photo or recording came from a specific camera or mic at capture time?
      - Can a capture attestation record whether AI was used to generate or alter the content?
      instructions:
      - text: 'Attest capture of {asset_kind} asset {asset_id} by device {actor_did} with media hash {media_hash}, AI used: {ai_content_disclosure}.'
        slots:
          asset_kind: requestBody.asset_kind
          asset_id: requestBody.asset_id
          actor_did: requestBody.actor_did
          media_hash: requestBody.media_hash
          ai_content_disclosure: requestBody.ai_content_disclosure
      - text: Log the original capture of {asset_id} from {actor_did}, hash {media_hash}, with C2PA manifest {c2pa_manifest_hash}.
        slots:
          asset_id: requestBody.asset_id
          actor_did: requestBody.actor_did
          media_hash: requestBody.media_hash
          c2pa_manifest_hash: requestBody.c2pa_manifest_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsshield/edit/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest an edit to a media asset
      effect: write
      questions:
      - Can I log an editing step on a photo or video and chain it back to its capture?
      - Does an edit attestation need the hash of the edited media?
      instructions:
      - text: 'Attest an edit of {asset_kind} asset {asset_id} by editor {actor_did}, new hash {media_hash}, AI used: {ai_content_disclosure}.'
        slots:
          asset_kind: requestBody.asset_kind
          asset_id: requestBody.asset_id
          actor_did: requestBody.actor_did
          media_hash: requestBody.media_hash
          ai_content_disclosure: requestBody.ai_content_disclosure
      - text: Log editor {actor_did}'s change to {asset_id} after attestation {prior_attestation_id}, new hash {media_hash}.
        slots:
          asset_id: requestBody.asset_id
          prior_attestation_id: requestBody.prior_attestation_id
          actor_did: requestBody.actor_did
          media_hash: requestBody.media_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsshield/publish/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest publication of a media asset
      effect: write
      questions:
      - How can a newsroom attest that it published a piece of media, linked to its edit history?
      - What publisher details are recorded when attesting a publish event?
      instructions:
      - text: 'Attest publication of {asset_kind} asset {asset_id} by publisher {actor_did}, hash {media_hash}, AI used: {ai_content_disclosure}.'
        slots:
          asset_kind: requestBody.asset_kind
          asset_id: requestBody.asset_id
          actor_did: requestBody.actor_did
          media_hash: requestBody.media_hash
          ai_content_disclosure: requestBody.ai_content_disclosure
      - text: Log that {actor_did} published {asset_id} following attestation {prior_attestation_id}.
        slots:
          actor_did: requestBody.actor_did
          asset_id: requestBody.asset_id
          prior_attestation_id: requestBody.prior_attestation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsshield/syndicate/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest syndication of published media
      effect: write
      questions:
      - Can a syndication partner attest they republished a story, pointing back to the original publish?
      - Is the original publisher carried along when syndication is attested?
      instructions:
      - text: 'Attest syndication of {asset_kind} asset {asset_id} by partner {actor_did}, hash {media_hash}, AI used: {ai_content_disclosure}.'
        slots:
          asset_kind: requestBody.asset_kind
          asset_id: requestBody.asset_id
          actor_did: requestBody.actor_did
          media_hash: requestBody.media_hash
          ai_content_disclosure: requestBody.ai_content_disclosure
      - text: Log partner {actor_did} republishing {asset_id} from publish attestation {prior_attestation_id}.
        slots:
          actor_did: requestBody.actor_did
          asset_id: requestBody.asset_id
          prior_attestation_id: requestBody.prior_attestation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsshield/takedown/attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest a takedown of published media
      effect: write
      questions:
      - How do I put a takedown of a published asset on the provenance record?
      - Can a takedown attestation name the party issuing it?
      instructions:
      - text: 'Attest takedown of {asset_kind} asset {asset_id} issued by {actor_did}, hash {media_hash}, AI used: {ai_content_disclosure}.'
        slots:
          asset_kind: requestBody.asset_kind
          asset_id: requestBody.asset_id
          actor_did: requestBody.actor_did
          media_hash: requestBody.media_hash
          ai_content_disclosure: requestBody.ai_content_disclosure
      - text: Log that {actor_did} pulled {asset_id}, linked to publish attestation {prior_attestation_id}.
        slots:
          actor_did: requestBody.actor_did
          asset_id: requestBody.asset_id
          prior_attestation_id: requestBody.prior_attestation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsshield/asset/{asset_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get every attestation for a media asset
      effect: read
      questions:
      - Can I see the full lifecycle of envelopes stored for one media asset?
      - What has been attested about a given asset from capture onward?
      instructions:
      - text: Get all stored envelopes for asset {asset_id}.
        slots:
          asset_id: path.asset_id
      - text: Show the lifecycle record of media asset {asset_id}.
        slots:
          asset_id: path.asset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsshield/asset/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify one media attestation's signatures
      effect: read
      questions:
      - Is the dual-signed receipt on a media asset's attestation valid?
      - If I don't name an attestation, which one gets verified?
      instructions:
      - text: Verify the capture attestation of asset {asset_id}.
        slots:
          asset_id: requestBody.asset_id
      - text: Check signatures on attestation {attestation_id} for asset {asset_id}.
        slots:
          attestation_id: requestBody.attestation_id
          asset_id: requestBody.asset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsshield/chain/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a media asset's full provenance chain
      effect: read
      questions:
      - Is the chain from capture to edit to publish intact for a piece of media?
      - Can I trace and verify every link in an asset's provenance?
      instructions:
      - text: Verify the full lifecycle chain for asset {asset_id}.
        slots:
          asset_id: requestBody.asset_id
      - text: Trace provenance of {asset_id} from capture through publish.
        slots:
          asset_id: requestBody.asset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsshield/by-publisher/{publisher_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a publisher's publish history
      effect: read
      questions:
      - Which assets has a particular publisher DID published?
      - Can I page through a publisher's attested publications?
      instructions:
      - text: List publications by {publisher_did}.
        slots:
          publisher_did: path.publisher_did
      - text: Show {limit} publish events for {publisher_did} from offset {offset}.
        slots:
          limit: query.limit
          publisher_did: path.publisher_did
          offset: query.offset
      method: generated
      generated: '2026-09-26'