Skip to content

Commit 32c92bf

Browse files
committed
Merge branch '1.2.x'
2 parents 4c172f4 + 590b024 commit 32c92bf

File tree

42 files changed

+194
-192
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+194
-192
lines changed

CODE_OF_CONDUCT.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,5 @@ with regard to the reporter of an incident.
4242
This Code of Conduct is adapted from the [Contributor Covenant][1], version 1.3.0, available
4343
at [contributor-covenant.org/version/1/3/0/][2].
4444

45-
[1]: http://contributor-covenant.org
46-
[2]: http://contributor-covenant.org/version/1/3/0/
45+
[1]: https://contributor-covenant.org
46+
[2]: https://contributor-covenant.org/version/1/3/0/

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ The project can then be imported into Eclipse using `File -> Import…` and then
6161

6262
[1]: CODE_OF_CONDUCT.md
6363
[2]: https://cla.pivotal.io/sign/spring
64-
[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
64+
[3]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

docs/src/docs/asciidoc/contributing.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ your contributions.
1010
[[contributing-questions]]
1111
=== Questions
1212

13-
You can ask questions about Spring REST Docs on http://stackoverflow.com[Stack Overflow]
13+
You can ask questions about Spring REST Docs on https://stackoverflow.com[Stack Overflow]
1414
by using the `spring-restdocs` tag. Similarly, we encourage you to help your fellow
1515
Spring REST Docs users by answering questions.
1616

docs/src/docs/asciidoc/documenting-your-api.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1287,11 +1287,11 @@ A number of snippets are produced automatically when you document a request and
12871287
|Snippet | Description
12881288

12891289
| `curl-request.adoc`
1290-
| Contains the http://curl.haxx.se[`curl`] command that is equivalent to the `MockMvc`
1290+
| Contains the https://curl.haxx.se[`curl`] command that is equivalent to the `MockMvc`
12911291
call that is being documented.
12921292

12931293
| `httpie-request.adoc`
1294-
| Contains the http://httpie.org[`HTTPie`] command that is equivalent to the `MockMvc`
1294+
| Contains the https://httpie.org[`HTTPie`] command that is equivalent to the `MockMvc`
12951295
call that is being documented.
12961296

12971297
| `http-request.adoc`

docs/src/docs/asciidoc/getting-started.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ If you want to jump straight in, a number of sample applications are available:
1818
| {samples}/rest-notes-spring-data-rest[Spring Data REST]
1919
| Maven
2020
| Demonstrates the creation of a getting started guide and an API guide for a service
21-
implemented by using http://projects.spring.io/spring-data-rest/[Spring Data REST].
21+
implemented by using https://projects.spring.io/spring-data-rest/[Spring Data REST].
2222

2323
| {samples}/rest-notes-spring-hateoas[Spring HATEOAS]
2424
| Gradle
2525
| Demonstrates the creation of a getting started guide and an API guide for a service
26-
implemented by using http://projects.spring.io/spring-hateoas/[Spring HATEOAS].
26+
implemented by using https://projects.spring.io/spring-hateoas/[Spring HATEOAS].
2727

2828
|===
2929

@@ -64,7 +64,7 @@ If you want to jump straight in, a number of sample applications are available:
6464
| {samples}/rest-notes-slate[Slate]
6565
| Gradle
6666
| Demonstrates the use of Spring REST Docs with Markdown and
67-
http://github.com/tripit/slate[Slate].
67+
https://github.com/tripit/slate[Slate].
6868

6969
| {samples}/testng[TestNG]
7070
| Gradle
@@ -263,7 +263,7 @@ from where it will be included in the jar file.
263263
Spring REST Docs uses Spring MVC's
264264
{spring-framework-docs}/testing.html#spring-mvc-test-framework[test framework],
265265
Spring WebFlux's {spring-framework-docs}/testing.html#webtestclient[`WebTestClient`], or
266-
http://www.rest-assured.io[REST Assured] to make requests to the service that you are
266+
http://rest-assured.io/[REST Assured] to make requests to the service that you are
267267
documenting. It then produces documentation snippets for the request and the resulting
268268
response.
269269

@@ -580,7 +580,7 @@ the resulting HTML files depends on whether you use Maven or Gradle:
580580

581581
You can then include the generated snippets in the manually created Asciidoc file
582582
(described earlier in this section) by using the
583-
http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
583+
https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
584584
You can use the `snippets` attribute that is automatically set by
585585
`spring-restdocs-asciidoctor` configured in the
586586
<<getting-started-build-configuration,build configuration>> to reference the snippets

docs/src/docs/asciidoc/index.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Andy Wilkinson; Jay Bryant
1212
:source: {github}/tree/{branch-or-tag}
1313
:samples: {source}/samples
1414
:templates: {source}spring-restdocs/src/main/resources/org/springframework/restdocs/templates
15-
:spring-boot-docs: http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle
15+
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle
1616
:spring-framework-docs: https://docs.spring.io/spring-framework/docs/5.0.x/spring-framework-reference
1717
:spring-framework-api: https://docs.spring.io/spring-framework/docs/5.0.x/javadoc-api
1818

docs/src/docs/asciidoc/introduction.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ your RESTful services.
66

77
Writing high-quality documentation is difficult. One way to ease that difficulty is to use
88
tools that are well-suited to the job. To this end, Spring REST Docs uses
9-
http://asciidoctor.org[Asciidoctor] by default. Asciidoctor processes plain text and
9+
https://asciidoctor.org[Asciidoctor] by default. Asciidoctor processes plain text and
1010
produces HTML, styled and laid out to suit your needs. If you prefer, you can also
1111
configure Spring REST Docs to use Markdown.
1212

1313
Spring REST Docs uses snippets produced by tests written with Spring MVC's
1414
{spring-framework-docs}/testing.html#spring-mvc-test-framework[test framework], Spring
1515
WebFlux's {spring-framework-docs}/testing.html#webtestclient[`WebTestClient`] or
16-
http://www.rest-assured.io[REST Assured 3]. This test-driven approach helps to guarantee
16+
http://rest-assured.io[REST Assured 3]. This test-driven approach helps to guarantee
1717
the accuracy of your service's documentation. If a snippet is incorrect, the test that
1818
produces it fails.
1919

docs/src/docs/asciidoc/working-with-asciidoctor.adoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ NOTE: Asciidoc is the document format. Asciidoctor is the tool that produces con
1212
[[working-with-asciidoctor-resources]]
1313
=== Resources
1414

15-
* http://asciidoctor.org/docs/asciidoc-syntax-quick-reference[Syntax quick reference]
16-
* http://asciidoctor.org/docs/user-manual[User manual]
15+
* https://asciidoctor.org/docs/asciidoc-syntax-quick-reference[Syntax quick reference]
16+
* https://asciidoctor.org/docs/user-manual[User manual]
1717

1818

1919

@@ -139,7 +139,7 @@ the `curl-request` snippet to be "Example request", you can use the following at
139139
[[working-with-asciidoctor-including-snippets-individual]]
140140
==== Including Individual Snippets
141141

142-
The http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include
142+
The https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include
143143
macro] is used to include individual snippets in your documentation. You can use the
144144
`snippets` attribute (which is automatically set by `spring-restdocs-asciidoctor`
145145
configured in the <<getting-started-build-configuration, build configuration>>) to
@@ -167,8 +167,8 @@ snippet is included or by using a custom snippet template.
167167
==== Formatting Columns
168168

169169
Asciidoctor has rich support for
170-
http://asciidoctor.org/docs/user-manual/#cols-format[formatting a table's columns]. As the
171-
following example shows, you can specify the widths of a table's columns by using the
170+
https://asciidoctor.org/docs/user-manual/#cols-format[formatting a table's columns]. As
171+
the following example shows, you can specify the widths of a table's columns by using the
172172
`cols` attribute:
173173

174174
====
@@ -222,5 +222,5 @@ in a cell that contains the value of a `description` attribute:
222222

223223
==== Further Reading
224224

225-
See the http://asciidoctor.org/docs/user-manual/#tables[Tables section of the
225+
See the https://asciidoctor.org/docs/user-manual/#tables[Tables section of the
226226
Asciidoctor user manual] for more information about customizing tables.

samples/rest-notes-grails/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Overview
44

55
This is a sample project using Grails 3, Spock, and Spring REST docs. For more
6-
information about the Grails framework please see [grails.org](http://grails.org).
6+
information about the Grails framework please see [grails.org](https://grails.org).
77

88
Grails is built on top of Spring Boot and Gradle so there are a few different ways to
99
run this project including:

samples/rest-notes-grails/grails-app/conf/logback.groovy

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import grails.util.BuildSettings
1818
import grails.util.Environment
1919

20-
// See http://logback.qos.ch/manual/groovy.html for details on configuration
20+
// See https://logback.qos.ch/manual/groovy.html for details on configuration
2121
appender('STDOUT', ConsoleAppender) {
2222
encoder(PatternLayoutEncoder) {
2323
pattern = "%level %logger - %msg%n"

samples/rest-notes-slate/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ documentation by [ERB][4]. The combined Markdown document is then turned into HT
2121
[1]: https://github.com/lord/slate
2222
[2]: slate/source/api-guide.html.md.erb
2323
[3]: src/test/java/com/example/notes/ApiDocumentation.java
24-
[4]: http://ruby-doc.org/stdlib-2.2.3/libdoc/erb/rdoc/ERB.html
24+
[4]: https://ruby-doc.org/stdlib-2.2.3/libdoc/erb/rdoc/ERB.html

samples/rest-notes-slate/slate/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Features
2727

2828
* **Let your users update your documentation for you** — By default, your Slate-generated documentation is hosted in a public Github repository. Not only does this mean you get free hosting for your docs with Github Pages, but it also makes it simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to use GitHub, you're also welcome to host your docs elsewhere.
2929

30-
Getting started with Slate is super easy! Simply fork this repository and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](http://lord.github.io/slate).
30+
Getting started with Slate is super easy! Simply fork this repository and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](https://lord.github.io/slate).
3131

3232
Getting Started with Slate
3333
------------------------------
@@ -67,18 +67,18 @@ Companies Using Slate
6767

6868
* [NASA](https://api.nasa.gov)
6969
* [IBM](https://docs.cloudant.com/api.html)
70-
* [Sony](http://developers.cimediacloud.com)
71-
* [Mozilla](http://localforage.github.io/localForage/)
70+
* [Sony](https://developers.cimediacloud.com)
71+
* [Mozilla](https://localforage.github.io/localForage/)
7272
* [Best Buy](https://bestbuyapis.github.io/api-documentation/)
7373
* [Travis-CI](https://docs.travis-ci.com/api/)
7474
* [Greenhouse](https://developers.greenhouse.io/harvest.html)
75-
* [Woocommerce](http://woocommerce.github.io/woocommerce-rest-api-docs/)
76-
* [Appium](http://appium.io/slate/en/master)
75+
* [Woocommerce](https://woocommerce.github.io/woocommerce-rest-api-docs/)
76+
* [Appium](https://appium.io/slate/en/master)
7777
* [Dwolla](https://docs.dwolla.com/)
7878
* [Clearbit](https://clearbit.com/docs)
7979
* [Coinbase](https://developers.coinbase.com/api)
80-
* [Parrot Drones](http://developer.parrot.com/docs/bebop/)
81-
* [Fidor Bank](http://docs.fidor.de/)
80+
* [Parrot Drones](https://developer.parrot.com/docs/bebop/)
81+
* [Fidor Bank](https://api-docs.fidor.de)
8282
* [Scale](https://docs.scaleapi.com/)
8383

8484
You can view more in [the list on the wiki](https://github.com/lord/slate/wiki/Slate-in-the-Wild).
@@ -100,12 +100,12 @@ Thanks to the following people who have submitted major pull requests:
100100
- [@realityking](https://github.com/realityking)
101101
- [@cvkef](https://github.com/cvkef)
102102

103-
Also, thanks to [Sauce Labs](http://saucelabs.com) for helping sponsor the project.
103+
Also, thanks to [Sauce Labs](https://saucelabs.com) for helping sponsor the project.
104104

105105
Special Thanks
106106
--------------------
107107
- [Middleman](https://github.com/middleman/middleman)
108108
- [jquery.tocify.js](https://github.com/gfranko/jquery.tocify.js)
109109
- [middleman-syntax](https://github.com/middleman/middleman-syntax)
110110
- [middleman-gh-pages](https://github.com/edgecase/middleman-gh-pages)
111-
- [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
111+
- [Font Awesome](https://fortawesome.github.io/Font-Awesome/)

samples/rest-notes-slate/slate/source/api-guide.html.md.erb

+3-3
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ that describes the problem. The error object has the following structure:
4949
## Hypermedia
5050

5151
RESTful Notes uses hypermedia and resources include links to other resources in their
52-
responses. Responses are in [Hypertext Application Language (HAL)](http://stateless.co/hal_specification.html format).
53-
Links can be found beneath the `_links` key. Users of the API should not create URIs
54-
themselves, instead they should use the above-described links to navigate
52+
responses. Responses are in [Hypertext Application Language (HAL)](https://github.com/mikekelly/hal_specification)
53+
format. Links can be found beneath the `_links` key. Users of the API should not create
54+
URIs themselves, instead they should use the above-described links to navigate
5555

5656

5757

samples/rest-notes-slate/slate/source/index.html.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ let api = kittn.authorize('meowmeowmeow');
5555

5656
> Make sure to replace `meowmeowmeow` with your API key.
5757
58-
Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our [developer portal](http://example.com/developers).
58+
Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our [developer portal](https://example.com/developers).
5959

6060
Kittn expects for the API key to be included in all API requests to the server in a header that looks like the following:
6161

@@ -84,7 +84,7 @@ api.kittens.get()
8484
```
8585

8686
```shell
87-
curl "http://example.com/api/kittens"
87+
curl "https://example.com/api/kittens"
8888
-H "Authorization: meowmeowmeow"
8989
```
9090

@@ -120,7 +120,7 @@ This endpoint retrieves all kittens.
120120

121121
### HTTP Request
122122

123-
`GET http://example.com/api/kittens`
123+
`GET https://example.com/api/kittens`
124124

125125
### Query Parameters
126126

@@ -150,7 +150,7 @@ api.kittens.get(2)
150150
```
151151

152152
```shell
153-
curl "http://example.com/api/kittens/2"
153+
curl "https://example.com/api/kittens/2"
154154
-H "Authorization: meowmeowmeow"
155155
```
156156

@@ -179,7 +179,7 @@ This endpoint retrieves a specific kitten.
179179

180180
### HTTP Request
181181

182-
`GET http://example.com/kittens/<ID>`
182+
`GET https://example.com/kittens/<ID>`
183183

184184
### URL Parameters
185185

samples/rest-notes-slate/slate/source/javascripts/app/_lang.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ under the License.
6565

6666
key = decodeURIComponent(key);
6767
// missing `=` should be `null`:
68-
// http://w3.org/TR/2012/WD-url-20120524/#collect-url-parameters
68+
// https://w3.org/TR/2012/WD-url-20120524/#collect-url-parameters
6969
val = val === undefined ? null : decodeURIComponent(val);
7070

7171
if (!ret.hasOwnProperty(key)) {

samples/rest-notes-slate/slate/source/javascripts/lib/_energize.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@
115115

116116
/**
117117
* Special logic for standalone web apps
118-
* See http://stackoverflow.com/questions/2898740/iphone-safari-web-app-opens-links-in-new-window
118+
* See https://stackoverflow.com/questions/2898740/iphone-safari-web-app-opens-links-in-new-window
119119
*/
120120
if(standAlone) {
121121
window.location = target.getAttribute("href");

samples/rest-notes-slate/slate/source/javascripts/lib/_jquery.highlight.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* jQuery Highlight plugin
33
*
44
* Based on highlight v3 by Johann Burkard
5-
* http://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html
5+
* https://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html
66
*
77
* Code a little bit refactored and cleaned (in my humble opinion).
88
* Most important changes:

0 commit comments

Comments
 (0)