Linting™

projects/authentication/docs/requesting-credentials.md

@@ -1,12 +1,14 @@
 # Requesting client credentials
 
 ## UiTPAS API & UiTdatabank APIs
+
 Before you can start making authenticated API requests to UiTPAS and/or UiTdatabank, you need to register your integration on our self-service platform [publiq platform](https://platform.publiq.be). In the registration process you'll need to pick the API you want to use:
+
 * [UiTPAS API](https://docs.publiq.be/docs/uitpas/introduction)
 * [UiTdatabank Entry API](https://docs.publiq.be/docs/uitdatabank/entry-api/introduction)
 * [UiTdatabank Search API](https://docs.publiq.be/docs/uitdatabank/search-api/introduction)
 
-Note that the UiTPAS API will also grant you access to the UiTdatabank Entry API. 
+Note that the UiTPAS API will also grant you access to the UiTdatabank Entry API.
 
 Registration and access to our test environment is free. After registration you'll immediately get your test credentials.
 

projects/release-notes/docs/uitdatabank/2024.md

@@ -4,17 +4,18 @@
 
 🛠 **Improvements**
 
-User interface: 
+User interface:
+
 * it is now possible to save executed searches on an existing saved search, besides creating a new saved search.
 * executed searches are now added as an URL parameter in your browser URL, making it possible to share a direct URL to an executed search, e.g. an URL to all online events with at least one videolink: `https://www.uitdatabank.be/search?query=attendanceMode%3Aonline+AND+videosCount%3A1`.
 * the query builder now allows you to start from an executed search and edit the search.
 
-
 ## February 15
 
 ✨ **New features**
 
 For every event, place & organizer created in UiTdatabank we now store its `completeness`. The completeness score is a number between 0 and 100 that indicates how complete the information of an event, place or organizer is.
+
 * Using the [avanced query field completeness](https://docs.publiq.be/docs/uitdatabank/search-api%2Fadvanced-queries#completeness) you can filter events, places and organizers by their completeness score.
 * Using the [sort parameter completeness](https://docs.publiq.be/docs/uitdatabank/search-api%2Fsorting#completeness) you can now sort data you retrieve from the API by its completeness.
 

projects/release-notes/docs/widgets/2024.md

@@ -10,7 +10,6 @@
 * Points required for an UiTPAS reward are now also displayed in the UiTPAS reward section on the detail page.
 * Reservation e-mail on the detail page is now a clickable mailto link.
 
-
 ## January 16
 
 ✨ **New features**

projects/uitdatabank/docs/entry-api/shared/labels.md

@@ -60,7 +60,7 @@ Alternatively, you can set a label using one of these endpoints:
 To remove a label **when updating an event/place/organizer in its entirety**, you can simply leave out the specific `label`.
 
 <!-- theme: danger -->
->
+
 > Exception: some existing labels or hiddenLabels may be kept on the event, even if they are not included in the update request. For example, if they were added via the UiTdatabank UI, or if the client or user making the request does not have sufficient permission to remove some specific labels.
 
 Alternatively, you can delete a label using one of these endpoints:

projects/uitdatabank/docs/search-api/advanced/advanced-queries.md

@@ -24,7 +24,7 @@ The value for this field must always be an [ISO 3166-1 alpha-2](https://en.wikip
 
 **Examples**
 
-Because a document can have address translations, you can search by a specific language, as in the example below. 
+Because a document can have address translations, you can search by a specific language, as in the example below.
 
 ```
 GET /places/?q=address.nl.addressCountry:BE 
@@ -288,9 +288,11 @@ GET /organizers/?q=completedLanguages:en
 ```
 
 ### completeness
+
 <!-- theme: info -->
 
 > #### New functionality 🚧
+>
 > `completeness` is a new parameter that is still under construction. At the moment the completeness is only calculated for events, places and organizers created after February 15, 2024.
 
 With the `completeness` field you can filter events, places and organizers by their completeness score. The completeness score is a number between 0 and 100 that indicates how complete the information of an event, place or organizer is.

projects/uitdatabank/docs/search-api/authentication.md

@@ -96,7 +96,7 @@ Host: https://search-test.uitdatabank.be
 
 API key authentication will be supported for the foreseeable future on Search API. However, if you already want to make your integration as future-proof as possible you can easily switch from API key authentication to client identification.
 
-On our [self-service portal](https://platform.publiq.be) you are able to request a client id for your existing integration. 
+On our [self-service portal](https://platform.publiq.be) you are able to request a client id for your existing integration.
 
 When you receive your new client id, you can update your application to include the client id in your API requests as described above using an `x-client-id` header instead of an `x-api-key` header, or a `clientId` query parameter instead of an `apiKey` query parameter.
 

projects/uitdatabank/docs/search-api/filters/default-filters.md

@@ -66,7 +66,7 @@ GET /offers/?workflowStatus=*&addressCountry=*&audienceType=*
 
 ## Disable all filters at once
 
-In order to disable all filters at once you can set the `disableDefaultFilters` parameter to `true`. 
+In order to disable all filters at once you can set the `disableDefaultFilters` parameter to `true`.
 
 ```
 GET /offers/?disableDefaultFilters=true

projects/uitdatabank/docs/search-api/filters/location.md

@@ -9,8 +9,9 @@ You can filter results from Search API based on the country the event / place /
 > By default, the search API will only return results that are in Belgium. In order to retrieve results outside Belgium you'll need to disable the default filter of the addressCountry URL parameter. You can reset this default as described in the [default filters guide](../filters/default-filters.md).
 
 The `addressCountry` is available as both an URL parameter and as an advanced query field:
-- URL parameter: `addressCountry`
-- Advanced query parameter: `address.{language}.addressCountry`
+
+* URL parameter: `addressCountry`
+* Advanced query parameter: `address.{language}.addressCountry`
 
 **Applicable on endpoints**
 
@@ -43,14 +44,16 @@ GET /places/?addressCountry=NL
 ## Filtering on regions
 
 publiq has a list of pre-indexed geographical shapes that represent the administrative state of Belgium. The geographical coördinates of events and places are then matched with pre-indexed geographical shapes for:
-- Provinces
-- Regions
-- Municipalities
-- Submunicipalities
+
+* Provinces
+* Regions
+* Municipalities
+* Submunicipalities
 
 Using the `regions` parameter, you can filter on pre-indexed geographical shapes or regions. `regions` is available as both an URL parameter and as an advanced query field:
-- URL parameter: `regions`
-- Advanced query parameter: `regions`
+
+* URL parameter: `regions`
+* Advanced query parameter: `regions`
 
 > Filtering by region uses a cache in advanced queries, which is faster but may be slightly out of date. The URL parameter on the other hand does the filtering on-demand, which is slower but always up to date.
 
@@ -104,7 +107,7 @@ The value for `addressLocality` can be any municipality in a supported language.
 
 **Examples**
 
-Because a document can have address translations, you can search by a specific language or alternatively use a wildcard instead of specifying a language, as in the example below. 
+Because a document can have address translations, you can search by a specific language or alternatively use a wildcard instead of specifying a language, as in the example below.
 
 ```
 GET /places/?q=address.fr.addressLocality:Bruxelles
@@ -120,8 +123,9 @@ GET /places/?q=address.\*.addressLocality:Bruxelles
 
 Filter on the postal code (zipcode) of an event, place or organizer with the `postalCode` field.
 The `postalCode` is available as both an URL parameter and as advanced query field:
-- URL parameter: `postalCode`
-- Advanced query parameter: `address.{language}.postalCode`
+
+* URL parameter: `postalCode`
+* Advanced query parameter: `address.{language}.postalCode`
 
 **Applicable on endpoints**
 
@@ -158,16 +162,17 @@ GET /events/?q=address.\*.postalCode:(3600 OR 3700)
 ## Filtering on a specific location
 
 You can filter on specific locations or venues using the ID of the location.
-- URL parameter: `id` (on the `/places` endpoint) or locationId (on `/events` endpoint)
-- Advanced query parameter: `id` (on the `/places` endpoint) or `location.id` (on `/events` endpoint)
+
+* URL parameter: `id` (on the `/places` endpoint) or locationId (on `/events` endpoint)
+* Advanced query parameter: `id` (on the `/places` endpoint) or `location.id` (on `/events` endpoint)
 
 <!-- theme: warning --> 
 
 > Although you can filter by a location's name (`location.name`), we do not recommend this approach because location names may change over time. Instead, we strongly advise filtering by the location's unique identifier for consistent and reliable results.
 
 **Applicable on endpoints**
 
-`/events` `/places` `/offers` 
+`/events` `/places` `/offers`
 
 **Possible values**
 
@@ -199,11 +204,12 @@ However, in order we recommend using the attendanceMode filter for that:
 GET /events/?q=attendanceMode:online
 ```
 
-## Filtering on a specific address 
+## Filtering on a specific address
 
 With the `streetAddress` field you can limit your results to a certain street or a specific address. The `streetAddress` is available as both an URL parameter and as advanced query field:
-- URL parameter: `streetAddress`
-- Advanced query parameter: `address.{language}.streetAddress`
+
+* URL parameter: `streetAddress`
+* Advanced query parameter: `address.{language}.streetAddress`
 
 **Applicable on endpoints**
 
@@ -273,7 +279,7 @@ Using bounds you can find items that are located in a specific region (a specifi
 
 **Possible values**
 
-Valid coordinates, decimal representations of latitude & longitude \(in that order\), separated by a comma.
+Valid coordinates, decimal representations of latitude & longitude (in that order), separated by a comma.
 
 > It's important that you pass the south-west coordinates first, and the north-east coordinates second.
 

projects/uitpas/docs/getting-started.md

@@ -10,7 +10,7 @@ On this page we outline the basic steps to integrate your application with UiTPA
 
 ## 1. Start on the test environment
 
-Create an integration on publiq platform, our self-service portal to request your credentials for the UiTPAS testing environment. 
+Create an integration on publiq platform, our self-service portal to request your credentials for the UiTPAS testing environment.
 
 <!-- focus: false -->
 

projects/uitpas/docs/registering-events.md

@@ -55,7 +55,8 @@ Click on the `Prijzen` tab in step 6, and provide a *Basistarief* that is not 0
 
 ### 3. Linking an UiTPAS organizer
 
-Click the `Organisatie toevoegen` tab. You can now either 
+Click the `Organisatie toevoegen` tab. You can now either
+
 * select an organizer you have used in the past for creating events
 * select a new organizer
 
@@ -65,14 +66,12 @@ UiTPAS organizers always have a grey `UiTPAS` badge next to them.
 
 ![](../assets/images/uitdatabank-uitpas-event-organizer.png)
 
-
 Once you have added your UiTPAS organizer, the applicable UiTPAS prices are automatically calculated by UiTdatabank:
 
 <!-- focus: false -->
 
 ![](../assets/images/uitdatabank-uitpas-event-price-calculated.png)
 
-
 ### 4. Done!
 
 Shortly after you have selected an UiTPAS organizer, you should see a new *UiTPAS* field appear in the form that looks like this:
@@ -81,7 +80,6 @@ Shortly after you have selected an UiTPAS organizer, you should see a new *UiTPA
 
 ![image.png](../assets/images/uitdatabank-uitpas-event-cardsystems.png)
 
-
 **If you see this field, your event is now registered as an UiTPAS event**, and you can optionally change the possible card systems that it belongs to if the UiTPAS organizer is active in multiple card systems.
 
 You can now **use its id in UiTPAS API requests** that require an event id, for example to register a ticket sale for it. You can find this id in the URL of the event's detail or edit page on UiTdatabank.

projects/uitpas/docs/test-dataset.md

@@ -56,7 +56,7 @@ When testing ticket sale requests, you'll need an UitpasNumber of a passholder.
 
 ## Group passes
 
-| UitpasNumber    |   Chip Number    | Social tariff | Coupons | Card status |           Comment           |
+| UitpasNumber    |    Chip Number   | Social tariff | Coupons | Card status |           Comment           |
 | --------------- | :--------------: | :-----------: | :-----: | :---------: | :-------------------------: |
 | `0900000045410` | `04D0AB6AF85C80` |      yes      |    no   |    active   |              -              |
 | `0900000191800` | `048B25DAEE3880` |       no      |   yes   |    active   | max. 50 ticketsales per day |
@@ -69,7 +69,7 @@ If you want to test rewards without creating your own rewards, you can use these
 | --------------------------------- | :----: | :-------: | :------------------: |
 | Test Voordeel Regio Gent          | `5687` |  `POINTS` | Without restrictions |
 | Test Welkomstvoordeel Regio Gent  | `5688` | `WELCOME` | Without restrictions |
-| Test Voordeel Regio Gent - 1/week | `5823` |  `POINTS` | 1 per week           |
+| Test Voordeel Regio Gent - 1/week | `5823` |  `POINTS` |      1 per week      |
 | Test Online Voordeel - 10/dag     | `5824` |  `POINTS` | Online Reward 10/day |
-| Test Vervallen Voordeel           | `5825` |  `POINTS` | Should not work      |
-| Test Vervallen Welkomsvoordeel    | `5826` | `WELCOME` | Should not work      |
+| Test Vervallen Voordeel           | `5825` |  `POINTS` |    Should not work   |
+| Test Vervallen Welkomsvoordeel    | `5826` | `WELCOME` |    Should not work   |