unit.yaml

title: pulp2-unit

description: >-
  Schema for a Pulp 2.x unit, as returned by content search API.

$schema: http://json-schema.org/draft-07/schema#

definitions:
  # ISO units (generic file)
  iso:
    type: object

    properties:
      # Type of the unit, e.g. "iso", "rpm", "srpm", "erratum" ...
      _content_type_id:
        const: iso

      # Filename (actually path)
      name:
        type: string

      # SHA256 checksum
      checksum:
        type: string
        pattern: "^[a-f0-9]{64}$"

      # Size in bytes
      size:
        # Ideally would be 'integer', but some old units have been stored
        # as non-integers, e.g.
        # RHEL4-U5-ia64-source-disc2.iso => 512251904.0
        type: number

      repository_memberships:
        type: array
        items:
          type: string

    required:
    - _content_type_id
    - name
    - checksum
    - size

  # RPM units
  rpm:
    type: object

    properties:
      # Type of the unit
      _content_type_id:
        enum:
        - rpm
        - srpm

      # ENVR components
      name:
        type: string
      epoch:
        type: string
      version:
        type: string
      release:
        type: string

      # Architecture
      arch:
        type: string

      # Filename of the rpm
      filename:
        anyOf:
        - type: string
        - type: "null"
      
      # source rpm filename
      sourcerpm:
        anyOf:
        - type: string
        - type: "null"

      # Short ID of key used to sign this RPM
      signing_key:
        anyOf:
        - type: string
        - type: "null"

      # Checksums in key/value pairs (key=algorithm, value=hex string).
      # All checksums are optional.
      checksums:
        type: object
        properties:
          md5:
            type: string
            pattern: "^[a-f0-9]{32}$"
          sha1:
            type: string
            pattern: "^[a-f0-9]{40}$"
          sha256:
            type: string
            pattern: "^[a-f0-9]{64}$"

      # SHA256 checksum.
      # This duplicates checksums.sha256 above; the difference is that this field
      # is a part of the unit key, so it's both mandatory & indexed.
      # Also, though the original intent was probably to support multiple checksum
      # types in this field, it is nowadays forced to sha256, see:
      # https://github.com/pulp/pulp_rpm/blob/69759d0fb9a16c0a47b1f49c78f6712e650912e1/plugins/pulp_rpm/plugins/importers/yum/upload.py#L436
      checksum:
        type: string
        pattern: "^[a-f0-9]{64}$"

      repository_memberships:
        type: array
        items:
          type: string

      requires:
        type: array
        items:
          type: object

      provides:
        type: array
        items:
          type: object


    required:
    - _content_type_id
    - name
    - version
    - release
    - arch

  # modulemd units
  modulemd:
    type: object

    properties:
      # Type of the unit
      _content_type_id:
        const: modulemd

      # NSVCA components
      name:
        type: string
      stream:
        type: string
      version:
        type: integer
      context:
        type: string
      arch:
        type: string

      repository_memberships:
        type: array
        items:
          type: string

      artifacts:
        type: array
        items:
          type: string
      
      profiles:
        type: object

      dependencies:
        type: array
        items:
          type: object  

    required:
    - _content_type_id
    - name
    - stream
    - version
    - context
    - arch


  # modulemd_defaults units
  modulemd_defaults:
    type: object

    properties:
      # Type of the unit
      _content_type_id:
        const: modulemd_defaults

      name:
        type: string
      repo_id:
        type: string
      stream:
        type: string
      profiles:
        type: object

      repository_memberships:
        type: array
        items:
          type: string

    required:
    - _content_type_id
    - name
    - repo_id

  # Schema for any unknown type of unit
  unknown:
    type: object

    properties:
      # Type of the unit. Since this is the catch-all schema for unknown unit types,
      # this must be a type not included in one of the other schemas.
      _content_type_id:
        allOf:
        - type: string
        - not:
            enum:
            - iso
            - rpm
            - srpm
            - modulemd
            - modulemd_defaults

    required:
    - _content_type_id

anyOf:
- $ref: "#/definitions/iso"
- $ref: "#/definitions/rpm"
- $ref: "#/definitions/modulemd"
- $ref: "#/definitions/modulemd_defaults"
- $ref: "#/definitions/unknown"