Skip to content

Latest commit

 

History

History
380 lines (246 loc) · 15.8 KB

ExtensionRepositoryApi.md

File metadata and controls

380 lines (246 loc) · 15.8 KB

{{classname}}

All URIs are relative to /

Method HTTP request Description
GetExtensionRepoArtifacts Get /extension-repository/{bucketName}/{groupId} Get extension repo artifacts
GetExtensionRepoBuckets Get /extension-repository Get extension repo buckets
GetExtensionRepoGroups Get /extension-repository/{bucketName} Get extension repo groups
GetExtensionRepoVersion Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version} Get extension repo version
GetExtensionRepoVersionContent Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content Get extension repo version content
GetExtensionRepoVersionExtension Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name} Get extension repo extension
GetExtensionRepoVersionExtensionAdditionalDetailsDocs Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details Get extension repo extension details
GetExtensionRepoVersionExtensionDocs Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs Get extension repo extension docs
GetExtensionRepoVersionExtensions Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions Get extension repo extensions
GetExtensionRepoVersionSha256 Get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256 Get extension repo version checksum
GetExtensionRepoVersions Get /extension-repository/{bucketName}/{groupId}/{artifactId} Get extension repo versions
GetGlobalExtensionRepoVersionSha256 Get /extension-repository/{groupId}/{artifactId}/{version}/sha256 Get global extension repo version checksum

GetExtensionRepoArtifacts

[]ExtensionRepoArtifact GetExtensionRepoArtifacts(ctx, bucketName, groupId) Get extension repo artifacts

Gets the artifacts in the extension repository in the given bucket and group. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketName string The bucket name
groupId string The group id

Return type

[]ExtensionRepoArtifact

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionRepoBuckets

[]ExtensionRepoBucket GetExtensionRepoBuckets(ctx, ) Get extension repo buckets

Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

This endpoint does not need any parameter.

Return type

[]ExtensionRepoBucket

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionRepoGroups

[]ExtensionRepoGroup GetExtensionRepoGroups(ctx, bucketName) Get extension repo groups

Gets the groups in the extension repository in the given bucket. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketName string The bucket name

Return type

[]ExtensionRepoGroup

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionRepoVersion

ExtensionRepoVersion GetExtensionRepoVersion(ctx, bucketName, groupId, artifactId, version) Get extension repo version

Gets information about the version in the given bucket, group, and artifact. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketName string The bucket name
groupId string The group identifier
artifactId string The artifact identifier
version string The version

Return type

ExtensionRepoVersion

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionRepoVersionContent

string GetExtensionRepoVersionContent(ctx, bucketName, groupId, artifactId, version) Get extension repo version content

Gets the binary content of the bundle with the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketName string The bucket name
groupId string The group identifier
artifactId string The artifact identifier
version string The version

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionRepoVersionExtension

Extension GetExtensionRepoVersionExtension(ctx, bucketName, groupId, artifactId, version, name) Get extension repo extension

Gets information about the extension with the given name in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketName string The bucket name
groupId string The group identifier
artifactId string The artifact identifier
version string The version
name string The fully qualified name of the extension

Return type

Extension

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionRepoVersionExtensionAdditionalDetailsDocs

GetExtensionRepoVersionExtensionAdditionalDetailsDocs(ctx, bucketName, groupId, artifactId, version, name) Get extension repo extension details

Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketName string The bucket name
groupId string The group identifier
artifactId string The artifact identifier
version string The version
name string The fully qualified name of the extension

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionRepoVersionExtensionDocs

GetExtensionRepoVersionExtensionDocs(ctx, bucketName, groupId, artifactId, version, name) Get extension repo extension docs

Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketName string The bucket name
groupId string The group identifier
artifactId string The artifact identifier
version string The version
name string The fully qualified name of the extension

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionRepoVersionExtensions

[]ExtensionMetadata GetExtensionRepoVersionExtensions(ctx, bucketName, groupId, artifactId, version) Get extension repo extensions

Gets information about the extensions in the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketName string The bucket name
groupId string The group identifier
artifactId string The artifact identifier
version string The version

Return type

[]ExtensionMetadata

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionRepoVersionSha256

GetExtensionRepoVersionSha256(ctx, bucketName, groupId, artifactId, version) Get extension repo version checksum

Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketName string The bucket name
groupId string The group identifier
artifactId string The artifact identifier
version string The version

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionRepoVersions

[]ExtensionRepoVersionSummary GetExtensionRepoVersions(ctx, bucketName, groupId, artifactId) Get extension repo versions

Gets the versions in the extension repository for the given bucket, group, and artifact. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketName string The bucket name
groupId string The group identifier
artifactId string The artifact identifier

Return type

[]ExtensionRepoVersionSummary

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGlobalExtensionRepoVersionSha256

GetGlobalExtensionRepoVersionSha256(ctx, groupId, artifactId, version) Get global extension repo version checksum

Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string The group identifier
artifactId string The artifact identifier
version string The version

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]