/
doc.pb.go
72 lines (68 loc) · 2.55 KB
/
doc.pb.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
// Copyright 2020-2022 Buf Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by protoc-gen-go-api. DO NOT EDIT.
package registryv1alpha1api
import (
context "context"
v1alpha1 "github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/registry/v1alpha1"
)
// DocService defines a set of APIs that are intended for use by bufwebd only.
// This is not intended for general use; changes and use cases are subject to executive approval.
type DocService interface {
// GetSourceDirectoryInfo retrieves the directory and file structure for the
// given owner, repository and reference.
//
// The purpose of this is to get a representation of the file tree for a given
// module to enable exploring the module by navigating through its contents.
GetSourceDirectoryInfo(
ctx context.Context,
owner string,
repository string,
reference string,
) (root *v1alpha1.FileInfo, err error)
// GetSourceFile retrieves the source contents for the given owner, repository,
// reference, and path.
GetSourceFile(
ctx context.Context,
owner string,
repository string,
reference string,
path string,
) (content []byte, err error)
// GetModulePackages retrieves the list of packages for the module based on the given
// owner, repository, and reference.
GetModulePackages(
ctx context.Context,
owner string,
repository string,
reference string,
) (name string, modulePackages []*v1alpha1.ModulePackage, err error)
// GetModuleDocumentation retrieves the documentation for module based on the given
// owner, repository, and reference.
GetModuleDocumentation(
ctx context.Context,
owner string,
repository string,
reference string,
) (moduleDocumentation *v1alpha1.ModuleDocumentation, err error)
// GetPackageDocumentation retrieves a a slice of documentation structures
// for the given owner, repository, reference, and package name.
GetPackageDocumentation(
ctx context.Context,
owner string,
repository string,
reference string,
packageName string,
) (packageDocumentation *v1alpha1.PackageDocumentation, err error)
}