Skip to content

adds some description for adding dist extensions #302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 21, 2023
Merged

adds some description for adding dist extensions #302

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7864ebc
adds some description for adding dist extensions
mikebrow Oct 7, 2021
bbf8c12
Delete EXTENSIONS.md
jdolitsky Jun 21, 2023
f0e47f8
Update README.md
jdolitsky Jun 21, 2023
9983ecb
Update README.md
jdolitsky Jun 21, 2023
9956b71
Update README.md
jdolitsky Jun 21, 2023
03c4a1c
Update README.md
jdolitsky Jun 21, 2023
0df6824
Update README.md
jdolitsky Jun 21, 2023
2475bfd
Update README.md
jdolitsky Jun 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,23 @@ For general questions about OCI, please see the [FAQ on the OCI site](https://ww

The [GitHub milestones](https://github.com/opencontainers/distribution-spec/milestones) lay out the path to the future improvements.

# Extensions

The Distribution Specification Project is including, herein, a process and API for prototyping
and testing extensions to the Distribution API.

We invite contributions, comments, and reviews to these extensions.
These extensions will only move forward with significant support from registies, registry clients, and users.

Disclaimer: Unless stated otherwise, extension prototypes are subject to change. Extensions
should NOT be considered as final or approved official extensions to the OCI Distribution API until they
have been included in an OCI Distribution Specification.

## Extensions API - (status: WIP)

The Distribution maintainers recognize that an API may be necessary, or at least potentially advantageous, for specifying
extensions to the Distribution API. Thus, we propose to add an [Extensions API for Distribution](EXTENSIONS.md).

# Contributing

Development happens on GitHub for the spec.
Expand Down
13 changes: 13 additions & 0 deletions ext/EXTENSIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Extensions API for Distribution (WIP)

The Extensions API is for discovering service capability extensions to the Distribution API Specification.
This document will cover both the Extensions API and a process for adding new API extensions.

This API is considered to be a work in progress until such time as it has been included in a released
version of the Distribution Specification.


## Table of Contents

<!-- toc -->
<!-- /toc -->