max-length 100 prettier

Author: soyuka

.github/ISSUE_TEMPLATE/1_Support_question.md

@@ -5,8 +5,8 @@ about: See https://api-platform.com/support/ for questions about using API Platf
 
 # Support question
 
-We use GitHub issues only to discuss bugs and new features.
-For this kind of questions about using API Platform, please use
-any of the support alternatives shown in [API Platform support](https://api-platform.com/support/).
+We use GitHub issues only to discuss bugs and new features. For this kind of questions about using
+API Platform, please use any of the support alternatives shown in
+[API Platform support](https://api-platform.com/support/).
 
 Thanks!

CONTRIBUTING.md

@@ -2,7 +2,8 @@
 
 First of all, thank you for contributing, you're awesome!
 
-To have your code integrated in the API Platform documentation project, there are some rules to follow, but don't panic, it's easy!
+To have your code integrated in the API Platform documentation project, there are some rules to
+follow, but don't panic, it's easy!
 
 ## Reporting Bugs in the documentation
 
@@ -12,33 +13,36 @@ Before submitting your issue:
 - A clear title to resume the issue
 - A description of the workflow needed to reproduce the bug
 
-> [!NOTE]
-> Don't hesitate giving as much information as you can.
+> [!NOTE] Don't hesitate giving as much information as you can.
 
 ## Code of Conduct
 
-By contributing to this project, you agree to abide by our [Code of Conduct](https://github.com/api-platform/docs#coc-ov-file). We expect all contributors to foster a welcoming and inclusive environment.
+By contributing to this project, you agree to abide by our
+[Code of Conduct](https://github.com/api-platform/docs#coc-ov-file). We expect all contributors to
+foster a welcoming and inclusive environment.
 
 ## How to Contribute
 
-1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs` repository page.
+1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs`
+   repository page.
 
 2. Clone the forked repository to your local machine:
 
-   ```console
-     git clone https://github.com/your-username/repository-name.git
-   ```
+    ```console
+      git clone https://github.com/your-username/repository-name.git
+    ```
 
 3. Create a new branch for your contribution:
 
-   ```console
-     git switch -c docs-your-branch-name
-   ```
+    ```console
+      git switch -c docs-your-branch-name
+    ```
 
 4. Commit and push your changes
-5. Submit a Pull Request. You must decide on what branch your changes will be based depending of the nature of the change.
-   See [the dedicated documentation entry](https://api-platform.com/docs/extra/releases/).
+5. Submit a Pull Request. You must decide on what branch your changes will be based depending of the
+   nature of the change. See
+   [the dedicated documentation entry](https://api-platform.com/docs/extra/releases/).
 
-> [!TIP]
-> You can also contribute to improving the documentation directly by clicking on the
-> **"You can also help us improve the documentation of this page."** link, located at the end of each documentation page.
+> [!TIP] You can also contribute to improving the documentation directly by clicking on the **"You
+> can also help us improve the documentation of this page."** link, located at the end of each
+> documentation page.

README.md

@@ -4,7 +4,8 @@
 
 [![Lint](https://github.com/api-platform/docs/actions/workflows/ci.yml/badge.svg)](https://github.com/api-platform/docs/actions/workflows/ci.yml)
 
-Welcome to the official documentation for [API Platform](https://api-platform.com), a powerful framework for building APIs and web applications.
+Welcome to the official documentation for [API Platform](https://api-platform.com), a powerful
+framework for building APIs and web applications.
 
 This repository contains all the API Platform documentation resources.
 

admin/advanced-customization.md

@@ -2,13 +2,18 @@
 
 API Platform Admin delegates the authentication support to React Admin.
 
-Refer to the [Auth Provider Setup](https://marmelab.com/react-admin/Authentication.html) documentation for more information.
+Refer to the [Auth Provider Setup](https://marmelab.com/react-admin/Authentication.html)
+documentation for more information.
 
-**Tip:** Once you have set up the authentication, you can also configure React Admin to perform client-side Authorization checks. Refer to the [Authorization](https://marmelab.com/react-admin/Permissions.html) documentation for more information.
+**Tip:** Once you have set up the authentication, you can also configure React Admin to perform
+client-side Authorization checks. Refer to the
+[Authorization](https://marmelab.com/react-admin/Permissions.html) documentation for more
+information.
 
 ## HydraAdmin
 
-Enabling authentication support for [`<HydraAdmin>` component](./components.md#hydra) consists of a few parts, which need to be integrated together.
+Enabling authentication support for [`<HydraAdmin>` component](./components.md#hydra) consists of a
+few parts, which need to be integrated together.
 
 In the following steps, we will see how to:
 
@@ -18,52 +23,54 @@ In the following steps, we will see how to:
 
 ### Make Authenticated Requests
 
-First, we need to implement a `getHeaders` function, that will add the Bearer token from `localStorage` (if there is one) to the `Authorization` header.
+First, we need to implement a `getHeaders` function, that will add the Bearer token from
+`localStorage` (if there is one) to the `Authorization` header.
 
 ```typescript
 const getHeaders = () =>
-  localStorage.getItem("token")
-    ? { Authorization: `Bearer ${localStorage.getItem("token")}` }
-    : {};
+    localStorage.getItem("token")
+        ? { Authorization: `Bearer ${localStorage.getItem("token")}` }
+        : {};
 ```
 
-Then, extend the Hydra `fetch` function to use the `getHeaders` function to add the `Authorization` header to the requests.
+Then, extend the Hydra `fetch` function to use the `getHeaders` function to add the `Authorization`
+header to the requests.
 
 ```typescript
-import {
-    fetchHydra as baseFetchHydra,
-} from "@api-platform/admin";
+import { fetchHydra as baseFetchHydra } from "@api-platform/admin";
 
 const fetchHydra = (url, options = {}) =>
-  baseFetchHydra(url, {
-    ...options,
-    headers: getHeaders,
-  });
-
+    baseFetchHydra(url, {
+        ...options,
+        headers: getHeaders,
+    });
 ```
 
 ### Redirect To Login Page
 
-Then, we'll create a `<RedirectToLogin>` component, that will redirect users to the `/login` route if no token is available in the `localStorage`, and call the dataProvider's `introspect` function otherwise.
+Then, we'll create a `<RedirectToLogin>` component, that will redirect users to the `/login` route
+if no token is available in the `localStorage`, and call the dataProvider's `introspect` function
+otherwise.
 
 ```tsx
 import { Navigate } from "react-router-dom";
 import { useIntrospection } from "@api-platform/admin";
 
 const RedirectToLogin = () => {
-  const introspect = useIntrospection();
+    const introspect = useIntrospection();
 
-  if (localStorage.getItem("token")) {
-    introspect();
-    return <></>;
-  }
-  return <Navigate to="/login" />;
+    if (localStorage.getItem("token")) {
+        introspect();
+        return <></>;
+    }
+    return <Navigate to="/login" />;
 };
 ```
 
 ### Clear Expired Tokens
 
-Now, we will extend the `parseHydraDocumentaion` function (imported from the [@api-platform/api-doc-parser](https://github.com/api-platform/api-doc-parser) library).
+Now, we will extend the `parseHydraDocumentaion` function (imported from the
+[@api-platform/api-doc-parser](https://github.com/api-platform/api-doc-parser) library).
 
 We will customize it to clear expired tokens when encountering unauthorized `401` response.
 
@@ -72,39 +79,38 @@ import { parseHydraDocumentation } from "@api-platform/api-doc-parser";
 import { ENTRYPOINT } from "config/entrypoint";
 
 const apiDocumentationParser = (setRedirectToLogin) => async () => {
-  try {
-    setRedirectToLogin(false);
-    return await parseHydraDocumentation(ENTRYPOINT, { headers: getHeaders });
-  } catch (result) {
-    const { api, response, status } = result;
-    if (status !== 401 || !response) {
-      throw result;
-    }
+    try {
+        setRedirectToLogin(false);
+        return await parseHydraDocumentation(ENTRYPOINT, { headers: getHeaders });
+    } catch (result) {
+        const { api, response, status } = result;
+        if (status !== 401 || !response) {
+            throw result;
+        }
 
-    localStorage.removeItem("token");
-    setRedirectToLogin(true);
+        localStorage.removeItem("token");
+        setRedirectToLogin(true);
 
-    return { api, response, status };
-  }
+        return { api, response, status };
+    }
 };
 ```
 
 ### Extend The Data Provider
 
-Now, we can initialize the Hydra data provider with the custom `fetchHydra` (with custom headers) and `apiDocumentationParser` functions created earlier.
+Now, we can initialize the Hydra data provider with the custom `fetchHydra` (with custom headers)
+and `apiDocumentationParser` functions created earlier.
 
 ```typescript
-import {
-    hydraDataProvider as baseHydraDataProvider,
-} from "@api-platform/admin";
+import { hydraDataProvider as baseHydraDataProvider } from "@api-platform/admin";
 import { ENTRYPOINT } from "config/entrypoint";
 
 const dataProvider = (setRedirectToLogin) =>
-  baseHydraDataProvider({
-    entrypoint: ENTRYPOINT,
-    httpClient: fetchHydra,
-    apiDocumentationParser: apiDocumentationParser(setRedirectToLogin),
-  });
+    baseHydraDataProvider({
+        entrypoint: ENTRYPOINT,
+        httpClient: fetchHydra,
+        apiDocumentationParser: apiDocumentationParser(setRedirectToLogin),
+    });
 ```
 
 ### Update The Admin Component
@@ -168,22 +174,28 @@ export const Admin = () => {
 
 ### Example Implementation
 
-For the implementation of the admin component, you can find a working example in the [API Platform's demo application](https://github.com/api-platform/demo/blob/4.0/pwa/components/admin/Admin.tsx).
+For the implementation of the admin component, you can find a working example in the
+[API Platform's demo application](https://github.com/api-platform/demo/blob/4.0/pwa/components/admin/Admin.tsx).
 
 ## OpenApiAdmin
 
-This section explains how to set up and customize the [`<OpenApiAdmin>` component](./components.md/#openapi) to enable authentication.
+This section explains how to set up and customize the
+[`<OpenApiAdmin>` component](./components.md/#openapi) to enable authentication.
 
 In the following steps, we will see how to:
 
 - Make authenticated requests to the API (i.e. include the `Authorization` header)
-- Implement an authProvider to redirect users to the login page if they are not authenticated, and clear expired tokens when encountering unauthorized `401` response
+- Implement an authProvider to redirect users to the login page if they are not authenticated, and
+  clear expired tokens when encountering unauthorized `401` response
 
 ### Making Authenticated Requests
 
-First, we need to create a custom `httpClient` to add authentication tokens (via the the `Authorization` HTTP header) to requests.
+First, we need to create a custom `httpClient` to add authentication tokens (via the the
+`Authorization` HTTP header) to requests.
 
-We will then configure `openApiDataProvider` to use [`ra-data-simple-rest`](https://github.com/marmelab/react-admin/blob/master/packages/ra-data-simple-rest/README.md), a simple REST dataProvider for React Admin, and make it use the `httpClient` we created earlier.
+We will then configure `openApiDataProvider` to use
+[`ra-data-simple-rest`](https://github.com/marmelab/react-admin/blob/master/packages/ra-data-simple-rest/README.md),
+a simple REST dataProvider for React Admin, and make it use the `httpClient` we created earlier.
 
 ```typescript
 // src/dataProvider.ts
@@ -193,7 +205,7 @@ const getAccessToken = () => localStorage.getItem("token");
 const httpClient = async (url: string, options: fetchUtils.Options = {}) => {
     options.headers = new Headers({
         ...options.headers,
-        Accept: 'application/json',
+        Accept: "application/json",
     }) as Headers;
 
     const token = getAccessToken();
@@ -203,19 +215,23 @@ const httpClient = async (url: string, options: fetchUtils.Options = {}) => {
 };
 
 const dataProvider = openApiDataProvider({
-  dataProvider: simpleRestProvider(API_ENTRYPOINT_PATH, httpClient),
-  entrypoint: API_ENTRYPOINT_PATH,
-  docEntrypoint: API_DOCS_PATH,
+    dataProvider: simpleRestProvider(API_ENTRYPOINT_PATH, httpClient),
+    entrypoint: API_ENTRYPOINT_PATH,
+    docEntrypoint: API_DOCS_PATH,
 });
 ```
 
-**Note:** The `simpleRestProvider` provider expect the API to include a `Content-Range` header in the response. You can find more about the header syntax in the [Mozilla’s MDN documentation: Content-Range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range).
+**Note:** The `simpleRestProvider` provider expect the API to include a `Content-Range` header in
+the response. You can find more about the header syntax in the
+[Mozilla’s MDN documentation: Content-Range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range).
 
-**Note:** The `getAccessToken` function retrieves the JWT token stored in the browser's localStorage. Replace it with your own logic in case you don't store the token that way.
+**Note:** The `getAccessToken` function retrieves the JWT token stored in the browser's
+localStorage. Replace it with your own logic in case you don't store the token that way.
 
 ### Creating The AuthProvider
 
-Now let's create and export an `authProvider` object that handles authentication and authorization logic.
+Now let's create and export an `authProvider` object that handles authentication and authorization
+logic.
 
 ```typescript
 // src/authProvider.ts
@@ -228,7 +244,7 @@ interface JwtPayload {
 const getAccessToken = () => localStorage.getItem("token");
 
 const authProvider = {
-    login: async ({username, password}: { username: string; password: string }) => {
+    login: async ({ username, password }: { username: string; password: string }) => {
         const request = new Request(API_AUTH_PATH, {
             method: "POST",
             body: JSON.stringify({ email: username, password }),
@@ -248,7 +264,7 @@ const authProvider = {
         localStorage.removeItem("token");
         return Promise.resolve();
     },
-    checkAuth: () => getAccessToken() ? Promise.resolve() : Promise.reject(),
+    checkAuth: () => (getAccessToken() ? Promise.resolve() : Promise.reject()),
     checkError: (error: { status: number }) => {
         const status = error.status;
         if (status === 401 || status === 403) {
@@ -279,22 +295,23 @@ export default authProvider;
 
 ### Updating The Admin Component
 
-Finally, we can update the `Admin` component to use the `authProvider` and `dataProvider` we created earlier.
+Finally, we can update the `Admin` component to use the `authProvider` and `dataProvider` we created
+earlier.
 
 ```tsx
 // src/Admin.tsx
 
-import { OpenApiAdmin } from '@api-platform/admin';
+import { OpenApiAdmin } from "@api-platform/admin";
 import authProvider from "./authProvider";
 import dataProvider from "./dataProvider";
 import { API_DOCS_PATH, API_ENTRYPOINT_PATH } from "./config/api";
 
 export default () => (
-  <OpenApiAdmin
-    entrypoint={API_ENTRYPOINT_PATH}
-    docEntrypoint={API_DOCS_PATH}
-    dataProvider={dataProvider}
-    authProvider={authProvider}
-  />
+    <OpenApiAdmin
+        entrypoint={API_ENTRYPOINT_PATH}
+        docEntrypoint={API_DOCS_PATH}
+        dataProvider={dataProvider}
+        authProvider={authProvider}
+    />
 );
 ```