Skip to content

Commit aa32c42

Browse files
committed
Replace all http:// links with https://
Because security
1 parent 0b2c891 commit aa32c42

File tree

15 files changed

+40
-40
lines changed

15 files changed

+40
-40
lines changed

docs/api-playbook/Development Lifecycle/API versioning/feauture_toggle.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Used to retrieve a list of configurations
4242
{
4343
"Type": "Person",
4444
"Configuration": {
45-
"ApiUrl": "http://www.hackney.gov.uk/person"
45+
"ApiUrl": "https://www.hackney.gov.uk/person"
4646
},
4747
"FeatureToggles": {
4848
"CreatePerson": true,
@@ -52,7 +52,7 @@ Used to retrieve a list of configurations
5252
{
5353
"Type": "ContactDetails",
5454
"Configuration": {
55-
"ApiUrl": "http://www.hackney.gov.uk/contactdetails"
55+
"ApiUrl": "https://www.hackney.gov.uk/contactdetails"
5656
},
5757
"FeatureToggles": {
5858
"AddContactDetails": true
@@ -61,7 +61,7 @@ Used to retrieve a list of configurations
6161
{
6262
"Type": "Tenure",
6363
"Configuration": {
64-
"ApiUrl": "http://www.hackney.gov.uk/tenure"
64+
"ApiUrl": "https://www.hackney.gov.uk/tenure"
6565
},
6666
"FeatureToggles": {
6767
"CreateTenure": true
@@ -70,7 +70,7 @@ Used to retrieve a list of configurations
7070
{
7171
"Domain": "Asset",
7272
"Configuration": {
73-
"ApiUrl": "http://www.hackney.gov.uk/asset"
73+
"ApiUrl": "https://www.hackney.gov.uk/asset"
7474
},
7575
"FeatureToggles": {
7676
"ViewAsset": false

docs/api-playbook/Development Lifecycle/Designing your API/api_design_principles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ We apply the RESTful web service principles to all kind of application (micro-)
1010

1111
We prefer REST-based APIs with JSON payloads.
1212

13-
An important principle for API design and usage is Postel’s Law, aka [The Robustness Principle](http://en.wikipedia.org/wiki/Robustness_principle) (see also [RFC 1122](https://tools.ietf.org/html/rfc1122)):
13+
An important principle for API design and usage is Postel’s Law, aka [The Robustness Principle](https://en.wikipedia.org/wiki/Robustness_principle) (see also [RFC 1122](https://tools.ietf.org/html/rfc1122)):
1414
> Be liberal in what you accept, be conservative in what you send.
1515
1616
### Reading:
@@ -25,7 +25,7 @@ Some interesting reads on the ** RESTful API ** design style and service archite
2525

2626
* [_Web APIs: From Start to Finish_](https://www.infoq.com/minibooks/emag-web-api/) - InfoQ (eMag);
2727

28-
* [_Thoughts on RESTful API Design_](http://restful-api-design.readthedocs.org/en/latest/) - Lessons-learned blog;
28+
* [_Thoughts on RESTful API Design_](https://restful-api-design.readthedocs.org/en/latest/) - Lessons-learned blog;
2929

3030
* [*Architectural Styles and the Design of Network-Based Software Architectures*](https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm) - Roy Fielding (Dissertation);
3131

docs/api-playbook/Development Lifecycle/Designing your API/compatibility.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Service clients should apply the robustness principle:
3636

3737
Service clients must be prepared for compatible API extensions of service providers:
3838

39-
- Be tolerant with unknown fields in the payload (see also Fowler’s ["TolerantReader"](http://martinfowler.com/bliki/TolerantReader.html) post), i.e. ignore new fields but do not eliminate them from payload if needed for subsequent PUT requests;
39+
- Be tolerant with unknown fields in the payload (see also Fowler’s ["TolerantReader"](https://martinfowler.com/bliki/TolerantReader.html) post), i.e. ignore new fields but do not eliminate them from payload if needed for subsequent PUT requests;
4040

4141
- Be prepared to handle HTTP status codes not explicitly specified in endpoint definitions. Note also, that status codes are extensible. Default handling is how you would treat the corresponding x00 code (see [RFC7231 Section 6](https://tools.ietf.org/html/rfc7231#section-6));
4242

@@ -63,7 +63,7 @@ Not ignoring unknown input fields is a specific deviation from Postel’s Law (e
6363
In specific situations, where a (known) input field is not needed anymore, it either can stay in the API definition with "not used anymore" description or can be removed from the API definition as long as the server ignores this specific parameter.
6464
## SHOULD Avoid Versioning:
6565

66-
When changing your RESTful APIs, do so in a compatible way and avoid generating additional API versions. Multiple versions can significantly complicate understanding, testing, maintaining, evolving, operating and releasing our systems [supplementary reading](http://martinfowler.com/articles/enterpriseREST.html)).
66+
When changing your RESTful APIs, do so in a compatible way and avoid generating additional API versions. Multiple versions can significantly complicate understanding, testing, maintaining, evolving, operating and releasing our systems [supplementary reading](https://martinfowler.com/articles/enterpriseREST.html)).
6767

6868
If changing an API can’t be done in a compatible way, then proceed in one of these three ways:
6969

docs/api-playbook/Development Lifecycle/Designing your API/data-formats.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Other media types may be used in following cases:
7878
Represent date and time format as [RFC 3339](#should-date-property-values-should-conform-to-rfc-3339).
7979
### HTTP headers:
8080

81-
HTTP headers including the proprietary headers use the [HTTP date format defined in RFC 7231](http://tools.ietf.org/html/rfc7231#section-7.1.1.1).
81+
HTTP headers including the proprietary headers use the [HTTP date format defined in RFC 7231](https://tools.ietf.org/html/rfc7231#section-7.1.1.1).
8282

8383
## MAY Use Standards for Country, Language and Currency Codes:
8484

@@ -136,14 +136,14 @@ components:
136136
137137
## SHOULD Date property values should conform to RFC 3339:
138138
139-
Use the date and time formats defined by [RFC 3339](http://tools.ietf.org/html/rfc3339#section-5.6):
139+
Use the date and time formats defined by [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6):
140140
141141
- for "date" use strings matching `date-fullyear "-" date-month "-" date-mday`, for example: `2015-05-28`;
142142

143143
- for "date-time" use strings matching `full-date "T" full-time`, for example `2015-05-28T14:07:17Z`;
144144

145145
Note that the [OpenAPI format](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types)
146-
"date-time" corresponds to "date-time" in the RFC) and `2015-05-28` for a date (note that the OpenAPI format "date" corresponds to "full-date" in the RFC). Both are specific profiles, a subset of the international standard [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601).
146+
"date-time" corresponds to "date-time" in the RFC) and `2015-05-28` for a date (note that the OpenAPI format "date" corresponds to "full-date" in the RFC). Both are specific profiles, a subset of the international standard [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
147147

148148
A zone offset may be used (both, in request and responses) — this is simply defined by the standards. However, we encourage restricting dates to UTC and without offsets. For example `2015-05-28T14:07:17Z` rather than `2015-05-28T14:07:17+00:00`. From experience we have learned that zone offsets are not easy to understand and often not correctly handled. Note also that zone offsets are different from local times that might be including daylight saving time. Localization of dates should be done by the services that provide user interfaces, if required.
149149

@@ -159,10 +159,10 @@ Schema based JSON properties that are by design durations and intervals could be
159159

160160
## SHOULD Use standards for Language, Country and Currency:
161161

162-
- [ISO 3166-1-alpha2 country](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2);
162+
- [ISO 3166-1-alpha2 country](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2);
163163

164164
- [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes);
165165

166166
- [BCP-47](https://tools.ietf.org/html/bcp47) (based on ISO 639-1) for language variants;
167167

168-
- [ISO 4217 currency codes](http://en.wikipedia.org/wiki/ISO_4217);
168+
- [ISO 4217 currency codes](https://en.wikipedia.org/wiki/ISO_4217);

docs/api-playbook/Development Lifecycle/Designing your API/http.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## MUST Use REST Maturity Level 2:
44

5-
We strive for a good implementation of [REST Maturity Level 2](http://martinfowler.com/articles/richardsonMaturityModelhtml#level2) as it enables us to build resource-oriented APIs that make full use of HTTP verbs and status codes. You can see this expressed by many rules throughout these guidelines, e.g.:
5+
We strive for a good implementation of [REST Maturity Level 2](https://martinfowler.com/articles/richardsonMaturityModelhtml#level2) as it enables us to build resource-oriented APIs that make full use of HTTP verbs and status codes. You can see this expressed by many rules throughout these guidelines, e.g.:
66

77
- [Avoid Actions — Think About Resources](resources.md#must-avoid-actions--think-about-resources);
88

@@ -73,11 +73,11 @@ PATCH requests are used to **update parts** of single resources, i.e. where only
7373

7474
2. Use PATCH with partial objects to only update parts of a resource, whenever possible. (This is basically [JSON Merge Patch](https://tools.ietf.org/html/rfc7396),a specialized media type `application/merge-patch+json` that is a partial resource representation.);
7575

76-
3. Use PATCH with [JSON Patch](http://tools.ietf.org/html/rfc6902), a specialized media type `application/json-patch+json` that includes instructions on how to change the resource;
76+
3. Use PATCH with [JSON Patch](https://tools.ietf.org/html/rfc6902), a specialized media type `application/json-patch+json` that includes instructions on how to change the resource;
7777

7878
4. Use POST (with a proper description of what is happening) instead of PATCH, if the request does not modify the resource in a way defined by the semantics of the media type;
7979

80-
In practice [JSON Merge Patch](https://tools.ietf.org/html/rfc7396) quickly turns out to be too limited, especially when trying to update single objects in large collections (as part of the resource). In this cases [JSON Patch](http://tools.ietf.org/html/rfc6902) can shown its full power while still showing readable patch requests (see also [JSON patch vs. merge](http://erosb.github.io/post/json-patch-vs-merge-patch)).
80+
In practice [JSON Merge Patch](https://tools.ietf.org/html/rfc7396) quickly turns out to be too limited, especially when trying to update single objects in large collections (as part of the resource). In this cases [JSON Patch](https://tools.ietf.org/html/rfc6902) can shown its full power while still showing readable patch requests (see also [JSON patch vs. merge](https://erosb.github.io/post/json-patch-vs-merge-patch)).
8181

8282
### DELETE:
8383

@@ -111,7 +111,7 @@ Content or entity headers are headers with a `Content-` prefix. They describe th
111111

112112
## MAY Use Other Standardized Headers:
113113

114-
Use [this list](http://en.wikipedia.org/wiki/List_of_HTTP_header_fields) and mention its support in your OpenAPI definition.
114+
Use [this list](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields) and mention its support in your OpenAPI definition.
115115

116116
## MUST Fulfill Safeness and Idempotency Properties:
117117

@@ -247,7 +247,7 @@ The before rules apply *even in the case* that processing of all individual part
247247
248248
## MUST Use Code 429 with Headers for Rate Limits:
249249
250-
APIs that wish to manage the request rate of clients must use the ['429 Too Many Requests'](http://tools.ietf.org/html/rfc6585) response code if the client exceeded the request rate and therefore the request can’t be fulfilled. Such responses must also contain header information providing further details to the client. There are two approaches a service can take for header information:
250+
APIs that wish to manage the request rate of clients must use the ['429 Too Many Requests'](https://tools.ietf.org/html/rfc6585) response code if the client exceeded the request rate and therefore the request can’t be fulfilled. Such responses must also contain header information providing further details to the client. There are two approaches a service can take for header information:
251251
252252
- Return a ['Retry-After'](https://tools.ietf.org/html/rfc7231#section-7.1.3) header indicating how long the client ought to wait before making a follow-up request. The Retry-After header can contain a HTTP date value to retry after or the number of seconds to delay. Either is acceptable but APIs should prefer to use a delay in seconds;
253253

docs/api-playbook/Development Lifecycle/Designing your API/pagination.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,6 @@ Further reading:
4747

4848
- [Twitter](https://dev.twitter.com/rest/public/timelines);
4949

50-
- [Use the Index, Luke](http://use-the-index-luke.com/no-offset);
50+
- [Use the Index, Luke](https://use-the-index-luke.com/no-offset);
5151

5252
- [Paging in PostgreSQL](https://www.citusdata.com/blog/1872-joe-nelson/409-five-ways-paginate-postgres-basic-exotic);

docs/api-playbook/Development Lifecycle/Designing your API/references.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This section collects links to documents to which we refer, and base our guideli
3838

3939
- [Build APIs You Won’t Hate](https://leanpub.com/build-apis-you-wont-hate);
4040

41-
- [InfoQ eBook - Web APIs: From Start to Finish](http://www.infoq.com/minibooks/emag-web-api);
41+
- [InfoQ eBook - Web APIs: From Start to Finish](https://www.infoq.com/minibooks/emag-web-api);
4242
## Blogs:
4343

44-
- [Lessons-learned blog: Thoughts on RESTful API Design](http://restful-api-design.readthedocs.org/en/latest/);
44+
- [Lessons-learned blog: Thoughts on RESTful API Design](https://restful-api-design.readthedocs.org/en/latest/);

docs/api-playbook/Development Lifecycle/How to build an API/Preferred tech stack/serverless_lambda.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ functions:
2828
environment:
2929
CONNECTION_STRING: Host=${ssm:/example-api/${self:provider.stage}/postgres-hostname};Port=${ssm:/example-api/${self:provider.stage}/postgres-port};Database=example-api-mirror;Username=${ssm:/example-api/${self:provider.stage}/postgres-username};Password=${ssm:/example-api/${self:provider.stage}/postgres-password}
3030
events:
31-
- http:
31+
- https:
3232
path: /{proxy+}
3333
method: ANY
3434
private: true

docs/api-playbook/Development Lifecycle/Implementing HTTP endpoints/PATCH endpoint/patch_dynamodb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ PATCH requests are used to **update parts** of single resources, i.e. where only
1919

2020
2. Use PATCH with partial objects to only update parts of a resource, whenever possible. (This is basically [JSON Merge Patch](https://tools.ietf.org/html/rfc7396),a specialized media type `application/merge-patch+json` that is a partial resource representation.);
2121

22-
3. Use PATCH with [JSON Patch](http://tools.ietf.org/html/rfc6902), a specialized media type `application/json-patch+json` that includes instructions on how to change the resource;
22+
3. Use PATCH with [JSON Patch](https://tools.ietf.org/html/rfc6902), a specialized media type `application/json-patch+json` that includes instructions on how to change the resource;
2323

2424
4. Use POST (with a proper description of what is happening) instead of PATCH, if the request does not modify the resource in a way defined by the semantics of the media type;
2525

26-
In practice [JSON Merge Patch](https://tools.ietf.org/html/rfc7396) quickly turns out to be too limited, especially when trying to update single objects in large collections (as part of the resource). In this cases [JSON Patch](http://tools.ietf.org/html/rfc6902) can shown its full power while still showing readable patch requests (see also [JSON patch vs. merge](http://erosb.github.io/post/json-patch-vs-merge-patch)).
26+
In practice [JSON Merge Patch](https://tools.ietf.org/html/rfc7396) quickly turns out to be too limited, especially when trying to update single objects in large collections (as part of the resource). In this cases [JSON Patch](https://tools.ietf.org/html/rfc6902) can shown its full power while still showing readable patch requests (see also [JSON patch vs. merge](https://erosb.github.io/post/json-patch-vs-merge-patch)).
2727

2828
[Here is an example PR to show how to build a PATCH endpoint using DynamoDB](https://github.com/LBHackney-IT/tenure-api/pull/45/files)
2929

docs/api-playbook/Development Lifecycle/Implementing HTTP endpoints/PATCH endpoint/patch_postgres.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ PATCH requests are used to **update parts** of single resources, i.e. where only
1919

2020
2. Use PATCH with partial objects to only update parts of a resource, whenever possible. (This is basically [JSON Merge Patch](https://tools.ietf.org/html/rfc7396),a specialized media type `application/merge-patch+json` that is a partial resource representation.);
2121

22-
3. Use PATCH with [JSON Patch](http://tools.ietf.org/html/rfc6902), a specialized media type `application/json-patch+json` that includes instructions on how to change the resource;
22+
3. Use PATCH with [JSON Patch](https://tools.ietf.org/html/rfc6902), a specialized media type `application/json-patch+json` that includes instructions on how to change the resource;
2323

2424
4. Use POST (with a proper description of what is happening) instead of PATCH, if the request does not modify the resource in a way defined by the semantics of the media type;
2525

26-
In practice [JSON Merge Patch](https://tools.ietf.org/html/rfc7396) quickly turns out to be too limited, especially when trying to update single objects in large collections (as part of the resource). In this cases [JSON Patch](http://tools.ietf.org/html/rfc6902) can shown its full power while still showing readable patch requests (see also [JSON patch vs. merge](http://erosb.github.io/post/json-patch-vs-merge-patch)).
26+
In practice [JSON Merge Patch](https://tools.ietf.org/html/rfc7396) quickly turns out to be too limited, especially when trying to update single objects in large collections (as part of the resource). In this cases [JSON Patch](https://tools.ietf.org/html/rfc6902) can shown its full power while still showing readable patch requests (see also [JSON patch vs. merge](https://erosb.github.io/post/json-patch-vs-merge-patch)).
2727

2828
We have created a video that gives developers a good understanding of how we build API Endpoints using Postgres from beginning to end, following best practices.
2929

0 commit comments

Comments
 (0)