name: iOS Vocabulary
description: >-
  Operational and capability vocabulary for the server-side surfaces Apple
  exposes to iOS developers. Words below are the canonical terms used across
  Apple's developer documentation; alignment to schema.org and JSON-LD context
  is in json-ld/ios-context.jsonld.
version: '0.1'
url: https://raw.githubusercontent.com/api-evangelist/ios/main/vocabulary/ios-vocabulary.yml

dimensions:
  platform:
    description: The Apple operating system platforms an iOS API surface can target.
    terms:
      - iOS
      - iPadOS
      - watchOS
      - tvOS
      - macOS
      - visionOS
  surface:
    description: Categories of developer surface Apple exposes.
    terms:
      - Client SDK
      - Server REST API
      - Webhook
      - Push Transport
      - Attestation Service
      - Identity Provider
      - Web Service Contract
  authentication:
    description: Authentication mechanisms across Apple's developer APIs.
    terms:
      - JWT (ES256)
      - JWT (ES256) client_secret
      - JWS-signed payload verification
      - TLS Client Certificate
      - Developer Token + User Token
      - API Key (App Store Connect)

services:
  - id: app-store-connect-api
    name: App Store Connect API
    purpose: Programmatic control of App Store Connect resources (apps, builds, TestFlight, IAP, subscriptions, Game Center, Xcode Cloud, reporting).
    style: REST / JSON:API
  - id: app-store-server-api
    name: App Store Server API
    purpose: Server-to-server inspection and mutation of in-app purchase / subscription state.
    style: REST + JWS
  - id: app-store-server-notifications
    name: App Store Server Notifications V2
    purpose: Webhook channel for IAP / subscription lifecycle events.
    style: Webhook + JWS
  - id: apns
    name: Apple Push Notification Service
    purpose: HTTP/2 push delivery to iOS / iPadOS / watchOS / tvOS / macOS devices.
    style: HTTP/2 + JSON
  - id: devicecheck
    name: DeviceCheck / App Attest
    purpose: Per-device state and app-instance integrity attestation.
    style: REST + JWT
  - id: sign-in-with-apple
    name: Sign in with Apple
    purpose: OpenID Connect-style identity provider for iOS / web apps.
    style: OAuth 2.0 / OIDC
  - id: apple-music-api
    name: Apple Music API
    purpose: Catalog, library, recommendations, ratings, search for Apple Music.
    style: REST + JWT
  - id: wallet-passkit-web-service
    name: Wallet / PassKit Web Service
    purpose: Web-service contract a pass provider must implement so Wallet can register devices and pull updated passes.
    style: REST contract (implemented by provider)

events:
  description: Notification types emitted by App Store Server Notifications V2.
  terms:
    - CONSUMPTION_REQUEST
    - DID_CHANGE_RENEWAL_PREF
    - DID_CHANGE_RENEWAL_STATUS
    - DID_FAIL_TO_RENEW
    - DID_RENEW
    - EXPIRED
    - EXTERNAL_PURCHASE_TOKEN
    - GRACE_PERIOD_EXPIRED
    - OFFER_REDEEMED
    - ONE_TIME_CHARGE
    - PRICE_INCREASE
    - REFUND
    - REFUND_DECLINED
    - REFUND_REVERSED
    - RENEWAL_EXTENDED
    - RENEWAL_EXTENSION
    - REVOKE
    - SUBSCRIBED
    - TEST

tags:
  - App Store Connect
  - App Store
  - TestFlight
  - In-App Purchases
  - Subscriptions
  - Push Notifications
  - Live Activities
  - Wallet
  - PassKit
  - Sign in with Apple
  - DeviceCheck
  - App Attest
  - Game Center
  - Xcode Cloud
  - Provisioning
  - Reporting
  - Reviews
  - Apple Music
  - MusicKit