openapi: 3.1.0
info:
  title: Pattern
  version: 2.0.0
  description: Schema definition for the Pattern entity in the Beckn Mobility domain.
  license:
    name: CC-BY-NC-SA 4.0 International
    url: https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en
  contact:
    name: Beckn Labs
    url: https://beckn.io
components:
  schemas:
    Pattern:
      x-iri: https://schema.nfh.global/Pattern/v2.0
      type: object
      title: Pattern
      description: A unique sequence of stops visited by trips on a route, grouping
        trips with identical stop sequences and timing structures.
      x-tags:
        - mobility
        - transmodel-netex
        - ride-hailing
      properties:
        patternId:
          description: Unique identifier for the journey pattern
          type: string
        routeRef:
          description: Reference to the route this pattern belongs to
          $ref: https://schema.nfh.global/Route/v2.0/attributes.yaml#/components/schemas/Route
        directionId:
          description: Direction of travel (0 or 1)
          type: string
        stops:
          description: Ordered list of stops in this pattern
          $ref: https://schema.nfh.global/Stop/v2.0/attributes.yaml#/components/schemas/Stop
        shapeRef:
          description: Reference to the geographic shape of this pattern
          $ref: https://schema.nfh.global/Shape/v2.0/attributes.yaml#/components/schemas/Shape
        id:
          description: Unique identifier for the item
          type: string
        descriptor:
          description: Human-readable description of the item
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
        categoryId:
          description: Category code classifying the item
          $ref: https://schema.nfh.global/CategoryCode/v2.1/attributes.yaml#/components/schemas/CategoryCode
        price:
          description: Price specification for this item
          $ref: https://schema.nfh.global/PriceSpecification/v2.1/attributes.yaml#/components/schemas/PriceSpecification
        quantity:
          description: Available quantity of the item
          $ref: https://schema.nfh.global/Quantity/v2.0/attributes.yaml#/components/schemas/Quantity
        tags:
          description: Tags associated with the item
          type: string
      additionalProperties: false