Skip to content
This repository has been archived by the owner on May 15, 2024. It is now read-only.

Commit

Permalink
Typo and annotation cleanup (#92)
Browse files Browse the repository at this point in the history
* Typo cleanup
Signed-off-by: Steve Lasker <stevenlasker@hotmail.com>
  • Loading branch information
SteveLasker committed Apr 6, 2022
1 parent 81ff510 commit 9ff738f
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 14 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ The high-level differences between the `oci.image.manifest` and the `oras.artifa
| | `/referrers` api for discovering referenced artifacts, with the ability to filter by `artifactType` |
| | Lifecycle management defined, starting to provide standard expectations for how users can manage their content |

For more info, see: [Discussion of a new manifest #41](https://github.com/opencontainers/artifacts/discussions/41)
For more info, see:
- [Proposal: Decoupling Registries from Specific Artifact Specs #91](https://github.com/oras-project/artifacts-spec/discussions/91)
- [Discussion of a new manifest #41](https://github.com/opencontainers/artifacts/discussions/41)

## Project status

Expand Down Expand Up @@ -92,6 +94,6 @@ This project has adopted the [CNCF Code of Conduct](CODE_OF_CONDUCT.md).
[cncf-distribution-artifacts]: https://github.com/oras-project/distribution/releases/tag/v0.0.3-alpha
[artifact-manifest-spec]: ./artifact-manifest.md
[artifact-referrers-spec]: ./manifest-referrers-api.md
[oras-cli]: https://github.com/oras-project/oras/releases/tag/v0.2.0-alpha.1
[oras-cli]: https://github.com/oras-project/oras/releases/tag/v0.2.1-alpha.1
[notation]: https://github.com/notaryproject/notation
[release]: https://github.com/oras-project/artifacts-spec/releases/tag/1.0.0-draft.1
[release]: https://github.com/oras-project/artifacts-spec/releases/tag/v1.0.0-draft.1.1
2 changes: 1 addition & 1 deletion artifact-manifest.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ORAS Artifact Manifest Spec

The ORAS Artifact manifest is similar to the [OCI image manifest][oci-image-manifest-spec], but removes constraints defined on the image-manifest such as a required `config` object and required & ordinal `layers`.
It then adds a `subject` property supporting a graph of independent, but link artifacts.
It adds a `subject` property supporting a graph of independently linked artifacts.
The addition of a new manifest does not change, nor impact the `image.manifest`.
It provides a means to define a wide range of artifacts, including a chain of related artifacts enabling SBoMs, on-demand loading, signatures and metadata that can be related to an `image.manifest`, `image.index` or another `artifact.manifest`.
By defining a new manifest, registries and clients opt-into new capabilities, without breaking existing registry and client behavior or setting expectations for scenarios to function when the client and/or registry may not yet implement new capabilities.
Expand Down
2 changes: 1 addition & 1 deletion examples/net-monitor-image-nydus-ondemand-loading.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@
"size": 16724
},
"annotations": {
"org.cncf.nydus.v1.author": "wabbit-networks.io"
"io.cncf.nydus.v1.author": "wabbit-networks.io"
}
}
3 changes: 2 additions & 1 deletion manifest-referrers-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ shown below.
GET /v2/{repository}/_oci/ext/discover
```

The reponse SHOULD contain an extension with the name of `cncf.oras.referrers`
The response SHOULD contain an extension with the name of `cncf.oras.referrers`
and the `url` path where the referrers can be requested.

```http
Expand Down Expand Up @@ -189,6 +189,7 @@ The value of the header would be:
Please see [RFC5988][rfc5988] for details.

### Sorting Results

The `/referrers` API MUST allow for artifacts to be sorted by the date and time in which they were created, which SHOULD be included in the artifact manifest's list of `annotations`.
The artifact's creation time MUST be the value of the `io.cncf.oras.artifact.created` annotation, as specified in the [artifact-manifest spec][artifact-manifest-spec].
The results of the `/referrers` API MUST list artifacts that were created more recently first.
Expand Down
4 changes: 2 additions & 2 deletions media/net-monitor-graph.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion media/net-monitor-sbom-signature.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions media/net-monitor-with-sigs-copy.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion media/notaryv2-signature.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9ff738f

Please sign in to comment.