models

Documentation

Overview

Package models defines the EPO Open Patent Services (OPS) catalogue JSON schema: Product → Delivery → Item → archive download URL.

These types mirror the JSON returned by the EPO bulk-data product catalogue and are consumed by the pipeline source to enumerate github.com/Qubut/epo-processor/internal/pipeline.ArchiveJob units of work.

Stability

The shape is dictated by EPO and changes only when EPO ships a new catalogue version. Adding fields is safe (json decoder ignores unknown keys); renaming requires a coordinated update.

Index

• type Delivery
• type Item
• type Product

Types

type Delivery

type Delivery struct {
	DeliveryID             uint32 `json:"deliveryId"`
	DeliveryName           string `json:"deliveryName"`
	DeliveryExpiryDatetime string `json:"deliveryExpiryDatetime,omitempty"`
	Items                  []Item `json:"items"`
}

Delivery is a periodic shipment within a Product (typically weekly). Each delivery aggregates one or more downloadable Item archives.

type Item

type Item struct {
	ItemID                  uint32 `json:"itemId"`
	ItemName                string `json:"itemName"`
	FileSize                string `json:"fileSize"`
	FileChecksum            string `json:"fileChecksum"`
	ItemPublicationDatetime string `json:"itemPublicationDatetime"`
}

Item is a single downloadable archive (typically a .tar or .zip) within a Delivery. FileChecksum is SHA-1, hex-encoded; case is catalogue-dependent and must be compared case-insensitively (see RFC 4648 §8).

type Product

type Product struct {
	ID         uint32     `json:"id"`
	Name       string     `json:"name"`
	Deliveries []Delivery `json:"deliveries"`
}

Product is a top-level entry in the EPO bulk-data catalogue (e.g. "EP full-text data"). One product groups many Delivery shipments.