README.md

Artifacts

Overview

REST APIs for working with Registry artifacts

Available Operations

• get_blob - Get blob for a particular digest
• get_manifest - Get manifest for a particular reference
• get_namespaces - Each namespace contains many revisions.
• get_oas_summary
• get_revisions
• get_tags
• post_tags - Add tags to an existing revision
• preflight - Get access token for communicating with OCI distribution endpoints

get_blob

Get blob for a particular digest

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::SpeakeasyClientSDK::SDK.new
s.config_security(
  ::SpeakeasyClientSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::SpeakeasyClientSDK::Operations::GetBlobRequest.new(
  digest: "<value>",
  namespace_name: "<value>",
  organization_slug: "<value>",
  workspace_slug: "<value>",
)
    
res = s.artifacts.get_blob(req)

if ! res.blob.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::SpeakeasyClientSDK::Operations::GetBlobRequest	✔️	The request object to use for the request.

Response

T.nilable(::SpeakeasyClientSDK::Operations::GetBlobResponse)

get_manifest

Get manifest for a particular reference

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::SpeakeasyClientSDK::SDK.new
s.config_security(
  ::SpeakeasyClientSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::SpeakeasyClientSDK::Operations::GetManifestRequest.new(
  namespace_name: "<value>",
  organization_slug: "<value>",
  revision_reference: "<value>",
  workspace_slug: "<value>",
)
    
res = s.artifacts.get_manifest(req)

if ! res.manifest.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::SpeakeasyClientSDK::Operations::GetManifestRequest	✔️	The request object to use for the request.

Response

T.nilable(::SpeakeasyClientSDK::Operations::GetManifestResponse)

get_namespaces

Each namespace contains many revisions.

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::SpeakeasyClientSDK::SDK.new
s.config_security(
  ::SpeakeasyClientSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.artifacts.get_namespaces()

if ! res.get_namespaces_response.nil?
  # handle response
end

Response

T.nilable(::SpeakeasyClientSDK::Operations::GetNamespacesResponse)

get_oas_summary

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::SpeakeasyClientSDK::SDK.new
s.config_security(
  ::SpeakeasyClientSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::SpeakeasyClientSDK::Operations::GetOASSummaryRequest.new(
  namespace_name: "<value>",
  revision_reference: "<value>",
)
    
res = s.artifacts.get_oas_summary(req)

if ! res.oas_summary.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::SpeakeasyClientSDK::Operations::GetOASSummaryRequest	✔️	The request object to use for the request.

Response

T.nilable(::SpeakeasyClientSDK::Operations::GetOASSummaryResponse)

get_revisions

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::SpeakeasyClientSDK::SDK.new
s.config_security(
  ::SpeakeasyClientSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::SpeakeasyClientSDK::Operations::GetRevisionsRequest.new(
  namespace_name: "<value>",
)
    
res = s.artifacts.get_revisions(req)

if ! res.get_revisions_response.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::SpeakeasyClientSDK::Operations::GetRevisionsRequest	✔️	The request object to use for the request.

Response

T.nilable(::SpeakeasyClientSDK::Operations::GetRevisionsResponse)

get_tags

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::SpeakeasyClientSDK::SDK.new
s.config_security(
  ::SpeakeasyClientSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::SpeakeasyClientSDK::Operations::GetTagsRequest.new(
  namespace_name: "<value>",
)
    
res = s.artifacts.get_tags(req)

if ! res.get_tags_response.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::SpeakeasyClientSDK::Operations::GetTagsRequest	✔️	The request object to use for the request.

Response

T.nilable(::SpeakeasyClientSDK::Operations::GetTagsResponse)

post_tags

Add tags to an existing revision

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::SpeakeasyClientSDK::SDK.new
s.config_security(
  ::SpeakeasyClientSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::SpeakeasyClientSDK::Operations::PostTagsRequest.new(
  namespace_name: "<value>",
)
    
res = s.artifacts.post_tags(req)

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::SpeakeasyClientSDK::Operations::PostTagsRequest	✔️	The request object to use for the request.

Response

T.nilable(::SpeakeasyClientSDK::Operations::PostTagsResponse)

preflight

Get access token for communicating with OCI distribution endpoints

Example Usage

require 'speakeasy_client_sdk_ruby'


s = ::SpeakeasyClientSDK::SDK.new
s.config_security(
  ::SpeakeasyClientSDK::Shared::Security.new(
    api_key: "<YOUR_API_KEY_HERE>",
  )
)


req = ::SpeakeasyClientSDK::Shared::PreflightRequest.new(
  namespace_name: "<value>",
)
    
res = s.artifacts.preflight(req)

if ! res.preflight_token.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::SpeakeasyClientSDK::Shared::PreflightRequest	✔️	The request object to use for the request.

Response

T.nilable(::SpeakeasyClientSDK::Operations::PreflightResponse)