Skip to content

URL Cleanup #602

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.

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

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ with regard to the reporter of an incident.
This Code of Conduct is adapted from the [Contributor Covenant][1], version 1.3.0, available
at [contributor-covenant.org/version/1/3/0/][2].

[1]: http://contributor-covenant.org
[2]: http://contributor-covenant.org/version/1/3/0/
[1]: https://contributor-covenant.org
[2]: https://contributor-covenant.org/version/1/3/0/
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ The project can then be imported into Eclipse using `File -> Import…` and then

[1]: CODE_OF_CONDUCT.md
[2]: https://cla.pivotal.io/sign/spring
[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[3]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
2 changes: 1 addition & 1 deletion docs/src/docs/asciidoc/contributing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ your contributions.
[[contributing-questions]]
=== Questions

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

Expand Down
4 changes: 2 additions & 2 deletions docs/src/docs/asciidoc/documenting-your-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1287,11 +1287,11 @@ A number of snippets are produced automatically when you document a request and
|Snippet | Description

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

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

| `http-request.adoc`
Expand Down
12 changes: 6 additions & 6 deletions docs/src/docs/asciidoc/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ If you want to jump straight in, a number of sample applications are available:
| {samples}/rest-notes-spring-data-rest[Spring Data REST]
| Maven
| Demonstrates the creation of a getting started guide and an API guide for a service
implemented by using http://projects.spring.io/spring-data-rest/[Spring Data REST].
implemented by using https://projects.spring.io/spring-data-rest/[Spring Data REST].

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

|===

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

| {samples}/testng[TestNG]
| Gradle
| Demonstrates the use of Spring REST Docs with http://testng.org[TestNG].

| {samples}/junit5[JUnit 5]
| Gradle
| Demonstrates the use of Spring REST Docs with http://junit.org/junit5/[JUnit 5].
| Demonstrates the use of Spring REST Docs with https://junit.org/junit5/[JUnit 5].

|===

Expand Down Expand Up @@ -263,7 +263,7 @@ from where it will be included in the jar file.
Spring REST Docs uses Spring MVC's
{spring-framework-docs}/testing.html#spring-mvc-test-framework[test framework],
Spring WebFlux's {spring-framework-docs}/testing.html#webtestclient[`WebTestClient`], or
http://www.rest-assured.io[REST Assured] to make requests to the service that you are
http://rest-assured.io/[REST Assured] to make requests to the service that you are
documenting. It then produces documentation snippets for the request and the resulting
response.

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

You can then include the generated snippets in the manually created Asciidoc file
(described earlier in this section) by using the
http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
You can use the `snippets` attribute that is automatically set by
`spring-restdocs-asciidoctor` configured in the
<<getting-started-build-configuration,build configuration>> to reference the snippets
Expand Down
2 changes: 1 addition & 1 deletion docs/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Andy Wilkinson; Jay Bryant
:source: {github}/tree/{branch-or-tag}
:samples: {source}/samples
:templates: {source}spring-restdocs/src/main/resources/org/springframework/restdocs/templates
:spring-boot-docs: http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle
:spring-framework-docs: https://docs.spring.io/spring-framework/docs/5.0.x/spring-framework-reference
:spring-framework-api: https://docs.spring.io/spring-framework/docs/5.0.x/javadoc-api

Expand Down
4 changes: 2 additions & 2 deletions docs/src/docs/asciidoc/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ your RESTful services.

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

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

Expand Down
10 changes: 5 additions & 5 deletions docs/src/docs/asciidoc/working-with-asciidoctor.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ NOTE: Asciidoc is the document format. Asciidoctor is the tool that produces con
[[working-with-asciidoctor-resources]]
=== Resources

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



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

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

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

Expand Down Expand Up @@ -222,5 +222,5 @@ in a cell that contains the value of a `description` attribute:

==== Further Reading

See the http://asciidoctor.org/docs/user-manual/#tables[Tables section of the
See the https://asciidoctor.org/docs/user-manual/#tables[Tables section of the
Asciidoctor user manual] for more information about customizing tables.
2 changes: 1 addition & 1 deletion samples/rest-notes-grails/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Overview

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

Grails is built on top of Spring Boot and Gradle so there are a few different ways to
run this project including:
Expand Down
2 changes: 1 addition & 1 deletion samples/rest-notes-grails/grails-app/conf/logback.groovy
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import grails.util.BuildSettings
import grails.util.Environment

// See http://logback.qos.ch/manual/groovy.html for details on configuration
// See https://logback.qos.ch/manual/groovy.html for details on configuration
appender('STDOUT', ConsoleAppender) {
encoder(PatternLayoutEncoder) {
pattern = "%level %logger - %msg%n"
Expand Down
2 changes: 1 addition & 1 deletion samples/rest-notes-slate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ documentation by [ERB][4]. The combined Markdown document is then turned into HT
[1]: https://github.com/lord/slate
[2]: slate/source/api-guide.html.md.erb
[3]: src/test/java/com/example/notes/ApiDocumentation.java
[4]: http://ruby-doc.org/stdlib-2.2.3/libdoc/erb/rdoc/ERB.html
[4]: https://ruby-doc.org/stdlib-2.2.3/libdoc/erb/rdoc/ERB.html
18 changes: 9 additions & 9 deletions samples/rest-notes-slate/slate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Features

* **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.

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).
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).

Getting Started with Slate
------------------------------
Expand Down Expand Up @@ -67,18 +67,18 @@ Companies Using Slate

* [NASA](https://api.nasa.gov)
* [IBM](https://docs.cloudant.com/api.html)
* [Sony](http://developers.cimediacloud.com)
* [Mozilla](http://localforage.github.io/localForage/)
* [Sony](https://developers.cimediacloud.com)
* [Mozilla](https://localforage.github.io/localForage/)
* [Best Buy](https://bestbuyapis.github.io/api-documentation/)
* [Travis-CI](https://docs.travis-ci.com/api/)
* [Greenhouse](https://developers.greenhouse.io/harvest.html)
* [Woocommerce](http://woocommerce.github.io/woocommerce-rest-api-docs/)
* [Appium](http://appium.io/slate/en/master)
* [Woocommerce](https://woocommerce.github.io/woocommerce-rest-api-docs/)
* [Appium](https://appium.io/slate/en/master)
* [Dwolla](https://docs.dwolla.com/)
* [Clearbit](https://clearbit.com/docs)
* [Coinbase](https://developers.coinbase.com/api)
* [Parrot Drones](http://developer.parrot.com/docs/bebop/)
* [Fidor Bank](http://docs.fidor.de/)
* [Parrot Drones](https://developer.parrot.com/docs/bebop/)
* [Fidor Bank](https://docs.fidor.de/)
* [Scale](https://docs.scaleapi.com/)

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

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

Special Thanks
--------------------
- [Middleman](https://github.com/middleman/middleman)
- [jquery.tocify.js](https://github.com/gfranko/jquery.tocify.js)
- [middleman-syntax](https://github.com/middleman/middleman-syntax)
- [middleman-gh-pages](https://github.com/edgecase/middleman-gh-pages)
- [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
- [Font Awesome](https://fortawesome.github.io/Font-Awesome/)
10 changes: 5 additions & 5 deletions samples/rest-notes-slate/slate/source/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ let api = kittn.authorize('meowmeowmeow');

> Make sure to replace `meowmeowmeow` with your API key.

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).
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).

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

Expand Down Expand Up @@ -84,7 +84,7 @@ api.kittens.get()
```

```shell
curl "http://example.com/api/kittens"
curl "https://example.com/api/kittens"
-H "Authorization: meowmeowmeow"
```

Expand Down Expand Up @@ -120,7 +120,7 @@ This endpoint retrieves all kittens.

### HTTP Request

`GET http://example.com/api/kittens`
`GET https://example.com/api/kittens`

### Query Parameters

Expand Down Expand Up @@ -150,7 +150,7 @@ api.kittens.get(2)
```

```shell
curl "http://example.com/api/kittens/2"
curl "https://example.com/api/kittens/2"
-H "Authorization: meowmeowmeow"
```

Expand Down Expand Up @@ -179,7 +179,7 @@ This endpoint retrieves a specific kitten.

### HTTP Request

`GET http://example.com/kittens/<ID>`
`GET https://example.com/kittens/<ID>`

### URL Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ under the License.

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

if (!ret.hasOwnProperty(key)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@

/**
* Special logic for standalone web apps
* See http://stackoverflow.com/questions/2898740/iphone-safari-web-app-opens-links-in-new-window
* See https://stackoverflow.com/questions/2898740/iphone-safari-web-app-opens-links-in-new-window
*/
if(standAlone) {
window.location = target.getAttribute("href");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* jQuery Highlight plugin
*
* Based on highlight v3 by Johann Burkard
* http://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html
* https://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html
*
* Code a little bit refactored and cleaned (in my humble opinion).
* Most important changes:
Expand Down
Loading