Update Example

[shizhMSFT]

Once we have the least code working, we should update the examples so that people can try themselves.

Examples (originally from @sajayantony 's list):

• Download Manifest
• Download a Blob given the digest
• Put Manifest
• Create manifest with Annotation
• Upload Blob
• Upload Manifest with blob
• Copy Artifact
• Insecure TLS / Plain HTTP
• HTTP Client Configuration

[sajayantony]

Add the list of items we potentially need as examples -

ORAS API Usecases

The following usecase can help define the list of examples that a new developer should be able to refer.

1. Download Manifest
2. Download a Blob given the digest
3. Put Manifest
4. Create manifest with Annotation
5. Upload Blob
6. Upload Manifest with blob
7. Copy Artifact
8. Upload manifest with reference
9. Download reference manifest
10. Download blob of reference manifest
11. Copy reference
12. Copy artifact and references

Authentication tokens

1. Get token for operation with scopes.
2. Validate cross mount

Example Permutations

1. Auth required for pull/push
2. Insecure planHttp

[shizhMSFT]

Assigning this item to @qweeah.

[qweeah]

Ack

[qweeah]

Add go-doc examples for registry target, including

• List repositories
• Push & pull layers and manifests
• Tag a image
• Resolve the tag
• Copy image
• List tags in a repository

[sajayantony]

@qweeah - can you include GetManifest in the examples.

[qweeah]

@qweeah - can you include GetManifest in the examples.

@sajayantony I think it's covered by Example_pullByTag and Example_pullByDigest

[shizhMSFT]

@wangxiaoxuan273 Could you help sweeping all the scenarios and add examples for them?

[wangxiaoxuan273]

@wangxiaoxuan273 Could you help sweeping all the scenarios and add examples for them?

Sure. Please assign this to me.

[Wwwsylvia]

I just noticed that there is no item related to referrers in the example list.
In the following items, does artifact reference mean subject here? Or do we actually mean referrers?

• Upload artifact reference manifest
• Download artifact reference manifest
• Download blob of artifact reference manifest
• Copy reference
• Copy artifact and references

The term reference seems to represent the artifact referencing the given manifest (which is a referrer of the given manifest) in ORAS Artifact Scenarios. I'm confused by the terms we are using here.

[wangxiaoxuan273]

ExampleRepository_Fetch_layer is an example of Download a Blob given the digest, so this item should be checked.

[shizhMSFT]

Closing as "HTTP Client Configuration" is tracked by #182 separately.