Skip to content

Commit

Permalink
Better warning for the old version
Browse files Browse the repository at this point in the history
  • Loading branch information
PonteIneptique committed Mar 11, 2024
1 parent 3d2801f commit 67d0f0a
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 1 deletion.
2 changes: 1 addition & 1 deletion specs-v1-alpha.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Specifications
## Status of this Document

- This Version: 1-alpha
- Previous Version: [1-draft2](./versions/1-draft2.)
- Previous Version: [1-draft2](./versions/1-draft2/)

<span style="color : red;">The current version is the closest we got to a release candidate. Feel free to provide feedback, typo corrections, etc.</span>

Expand Down
6 changes: 6 additions & 0 deletions versions/1-draft2/Collections.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## Status of this Document

- This Version: 1-draft2

<span style="color : red;">This document reflects the status of the version 1-draft2, check API Documentation for the current correct version.</span>

# Collection Endpoint

The collection endpoint is used for navigating collections. A collection contains metadata for the collection itself and an array of members. Each member is either a collection or the metadata for a document.
Expand Down
6 changes: 6 additions & 0 deletions versions/1-draft2/Document.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## Status of this Document

- This Version: 1-draft2

<span style="color : red;">This document reflects the status of the version 1-draft2, check API Documentation for the current correct version.</span>

# Document Endpoint

The Document endpoint is used to access and modify the content of document, as opposed to metadata (which is found in collections). Implementations must at least support reading document using `GET` requests as described below. The other request methods (POST, PUT, DELETE) are not required and they may be implemented selectively. For example, an implementation could allow `PUT` operations to update the contents of a document, but not support the total removal of document sections using `DELETE`. If an implementation is going to allow modification of document contents please do so using these methods as described below. An implementation should always document clearly which methods are supported for this endpoint. This should be included both in the human-readable API guidelines and in the endpoint's machine-readable documentation using the `supportedOperation` term. (See the section [Machine Readable Endpoint Documentation](#machine-readable-documentation-of-supported-methods) below.)
Expand Down
7 changes: 7 additions & 0 deletions versions/1-draft2/Entry.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## Status of this Document

- This Version: 1-draft2

<span style="color : red;">This document reflects the status of the version 1-draft2, check API Documentation for the current correct version.</span>


# Endpoint Basics

## Vocabulary
Expand Down
6 changes: 6 additions & 0 deletions versions/1-draft2/Navigation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## Status of this Document

- This Version: 1-draft2

<span style="color : red;">This document reflects the status of the version 1-draft2, check API Documentation for the current correct version.</span>

# Navigation Endpoint

The Navigation endpoint provides a JSON object listing passages that are accessible for navigation from a given reference within a resource. While the Collection endpoint allows for traversing of collections and their constituent Resources, the Navigation endpoint is used for traversing the internal citation tree of an individual Resource.
Expand Down
9 changes: 9 additions & 0 deletions versions/1-draft2/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
## Status of this Document

- This Version: 1-draft2

<span style="color : red;">This document reflects the status of the version 1-draft2, check API Documentation for the current correct version.</span>

-----


This part of the website / repository holds the Draft version 2 (Pre release of the Alpa)

The last change was performed December 2, 2022
Expand Down

0 comments on commit 67d0f0a

Please sign in to comment.