syncapi

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 15, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package syncapi is the request and response shapes for the hub sync endpoints: POST /v1/bundles/sync and POST /v1/plugins/{ns}/{id}/sync. (Named syncapi, not sync, so it does not shadow the standard library's sync package in consumers.)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Request

type Request struct {
	Repository string `json:"repository"`
	Tag        string `json:"tag"`
}

Request tells the hub which already-pushed artifact to fetch and index. Repository is a path within the registry (no host or scheme), e.g. "<ns>/plugins/<id>" for a plugin. Everything authoritative (identity, evaluates, entrypoint) comes from the signed artifact, never from this body.

type Response

type Response struct {
	Repository    string   `json:"repository"`
	Tag           string   `json:"tag"`
	ManifestEtag  string   `json:"manifest_etag"`
	ArtifactCount int      `json:"artifact_count"`
	NewCount      int      `json:"new_count"`
	Types         []string `json:"types"`
}

Response is the hub's reply to a catalog/bundle sync (POST /v1/bundles/sync). Repository and Tag echo the request; the rest summarize what was indexed. (The plugin sync path returns a different, plugin-specific shape that consumers read opaquely, so it is not modeled here.)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL