Skip to content

Commit 8545996

Browse files
supahgregkarianna
authored andcommitted
Add API v1 deprecation notices. Initial step towards #107 (#127)
1 parent 4cab018 commit 8545996

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# AdoptOpenJDK API
22

3-
For v1 docs see: [README.v1.md](README.v1.md)
3+
**NOTICE:** [AdoptOpenJDK API v1](/README.v1.md) has been deprecated and will be removed.
4+
If you are using v1 please move to the latest version (documented below) as soon as possible.
5+
6+
## Overview
47

58
The AdoptOpenJDK API provides a way to consume JSON information about the AdoptOpenJDK releases and nightly builds. Sign up to the [mailing list](https://mail.openjdk.java.net/mailman/listinfo/adoption-discuss) where major API updates will be announced, and visit [adoptopenjdk.net](https://adoptopenjdk.net) to find out more about the community.
69

@@ -36,7 +39,7 @@ function Get-RedirectedUrl
3639
$url= "https://api.adoptopenjdk.net/v2/binary/nightly/openjdk8?openjdk_impl=hotspot&os=windows&arch=x64&release=latest&type=jdk"
3740
3841
$fUrl = Get-RedirectedUrl $url
39-
$filename = [System.IO.Path]::GetFileName($fUrl);
42+
$filename = [System.IO.Path]::GetFileName($fUrl);
4043
4144
Write-Host "Downloading $filename"
4245
@@ -139,7 +142,7 @@ The data that can be returned can then be filtered to find builds of a specific
139142
| Binary Type | type | jdk, jre |
140143
| Heap Size | heap_size | normal, large |
141144

142-
In the absence of a given parameter, it will return all elements.
145+
In the absence of a given parameter, it will return all elements.
143146

144147
To return latest, hotspot, windows, x64, jdk:
145148
```

README.v1.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# AdoptOpenJDK API
1+
# AdoptOpenJDK API v1
2+
3+
## Notice of Deprecation
4+
5+
AdoptOpenJDK API v1 (i.e. the API documented here) has been deprecated and will be removed.
6+
If you are using v1 please move to [the latest version](/) as soon as possible.
7+
8+
## Overview
29

310
The AdoptOpenJDK API provides a way to consume JSON information about the AdoptOpenJDK releases and nightly builds. Sign up to the [mailing list](https://mail.openjdk.java.net/mailman/listinfo/adoption-discuss) where major API updates will be announced, and visit [adoptopenjdk.net](https://adoptopenjdk.net) to find out more about the community.
411

@@ -39,7 +46,7 @@ function Get-RedirectedUrl
3946
$url= "https://api.adoptopenjdk.net/v1/openjdk8/releases/x64_win/latest/binary"
4047
4148
$fUrl = Get-RedirectedUrl $url
42-
$filename = [System.IO.Path]::GetFileName($fUrl);
49+
$filename = [System.IO.Path]::GetFileName($fUrl);
4350
4451
Write-Host "Downloading $filename"
4552

markdown-layouts/layout.pug

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ html
1616

1717
footer
1818
hr
19-
| <strong>Last modfied:</strong> #{markdownFile.modified} <br/>
19+
| <strong>Last modified:</strong> #{markdownFile.modified} <br/>
2020

2121
script(src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js")
2222
script(src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js")

0 commit comments

Comments
 (0)