Skip to content

Commit 73b8a0e

Browse files
committed
fix lint
1 parent aa441c6 commit 73b8a0e

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

deployment/traefik.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
77
## Basic Implementation
88

9-
This tutorial will help you to define your own routes for your client, api and more generally for your containers.
9+
This tutorial will help you to define your own routes for your client, API and more generally for your containers.
1010

1111
Use this custom API Platform `docker-compose.yml` file which implements ready-to-use Træfik container configuration. Override
1212
ports and add labels to tell Træfik to listen on the routes mentioned and redirect routes to a specified container.
1313

1414
A few points to note:
1515

1616
* `--api.insecure=true` Tells Træfik to generate a browser view to watch containers and IP/DNS associated easier
17-
* `--providers.docker` Tells Træfik to listen on Docker Api
17+
* `--providers.docker` Tells Træfik to listen on Docker API
1818
* `labels:` Key for Træfik configuration into Docker integration
1919

2020
```yaml

extra/security.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Scores from the following areas are added together to produce a score. The score
4747

4848
* Integrity: Does this vulnerability cause non-public data to be accessible? If so, does the attacker have control over the data disclosed? (0-4)
4949
* Disclosure: Can this exploit allow system data (or data handled by the system) to be compromised? If so, does the attacker have control over modification? (0-4)
50-
* Code Execution: Does the vulnerability allow arbitrary code to be executed on an end-users system, or the server that it runs on? (0-4)
50+
* Code Execution: Does the vulnerability allow arbitrary code to be executed on an end users system, or the server that it runs on? (0-4)
5151
* Availability: Is the availability of a service or application affected? Is it reduced availability or total loss of availability of a service / application? Availability includes networked services (e.g., databases) or resources such as consumption of network bandwidth, processor cycles, or disk space. (0-4)
5252

5353
### Affected Projects

extra/troubleshooting.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Docker Toolbox is not supported anymore by API Platform. Please upgrade to [Dock
1212

1313
If the `php` container cannot start and display this `Error starting userland proxy: Bind for 0.0.0.0:80`, it means that port 80 is already in use. You can check to see which processes are currently listening on certain ports.
1414

15-
Find out if any service listens on port 80. You can use this command on UNIX-based OSes like MacOS and Linux:
15+
Find out if any service listens on port 80. You can use this command on UNIX-based OSes like macOS and Linux:
1616

1717
```console
1818
sudo lsof -n -i :80 | grep LISTEN
@@ -46,9 +46,9 @@ The JMS Serializer service is available as `jms_serializer`.
4646

4747
## "upstream sent too big header while reading response header from upstream" NGINX 502 Error
4848

49-
Some of your API calls fail with a 502 error and the logs for the api container shows the following error message `upstream sent too big header while reading response header from upstream`.
49+
Some of your api calls fail with a 502 error and the logs for the api container shows the following error message `upstream sent too big header while reading response header from upstream`.
5050

51-
This can be due to the cache invalidation headers that are too big for NGINX. When you query the API, API Platform adds the ids of all returned entities and their dependencies in the headers like so : `Cache-Tags: /entity/1,/dependent_entity/1,/entity/2`. This can overflow the default header size (4k) when your API gets larger and more complex.
51+
This can be due to the cache invalidation headers that are too big for NGINX. When you query the API, API Platform adds the IDs of all returned entities and their dependencies in the headers like so : `Cache-Tags: /entity/1,/dependent_entity/1,/entity/2`. This can overflow the default header size (4k) when your API gets larger and more complex.
5252

5353
You can modify the `api/docker/nginx/conf.d/default.conf` file and set values to `fastcgi_buffer_size` and `fastcgi_buffers` that suit your needs, like so:
5454

schema-generator/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The Schema Generator
22

3-
`schema` is a command line tool part of [the API Platform framework](https://api-platform.com) that instantly generates a set
3+
`schema` is a command-line tool part of [the API Platform framework](https://api-platform.com) that instantly generates a set
44
of PHP classes from [RDF](https://en.wikipedia.org/wiki/Resource_Description_Framework) vocabularies such as (but not limited to)
55
[Schema.org](https://schema.org) or [ActivityStreams](https://www.w3.org/TR/activitystreams-core/).
66
Alternatively, it can generate PHP classes from an [OpenAPI](https://www.openapis.org/) documentation.

0 commit comments

Comments
 (0)