Merge branch 'main' into dependabot/npm_and_yarn/axios-1.6.0

CONTRIBUTING.md

@@ -1,64 +1,23 @@
 # Contributing to Zion
 
-VAIMEE believes in the community of talented open source developers. Any contribution is welcomed, whether it be a bug fix, a new feature, a new tool, or a new way of thinking. This document provides a short how-to and a set of guidelines to follow when contributing to Zion.
+Please follow the generic instructions you can find in our organization [CONTRIBUTING.md](https://github.com/vaimee/.github/blob/main/CONTRIBUTING.md) file.
 
-## How to contribute with code
-We use github to host code, track issues, feature requests, and accept pull requests. When we reach the `1.0.0` all code changes must happen using [Github Flow](https://guides.github.com/introduction/flow/index.html), so **all** code changes happen through pull requests. 
-We actively welcome your pull requests:
+## Project specific remarks
 
-1. Fork the repo and create your branch from `main`.
-2. If you've added code, add tests to validate it.
-3. If you've changed APIs, update the documentation.
-4. Ensure the test suite passes.
-5. Make sure your code lints.
-6. Issue that pull request!
-
-If your PR fixes a bug or an issue, make sure to mention the issue number in the PR title, PR body, or commit message. If the issue does not exist, please take some time to create it.
-
-### Commit messages
-
-We use [Conventional Commit Messages](https://www.conventionalcommits.org/en/v1.0.0/#specification) to ensure that all commits are well-formed. Additionally to the standard commit types, we use the following custom commit types:
-- `docs`: for commits that update the documentation.
-- `test`: for commits that update the test suite.
-- `style`: for commits that update the style.
-- `refactor`: for commits meant to be refactoring.
-- `chore`: for commits that modify external scripts or `packages.json` dependencies.
-
-Examples:
-```
-docs: define a new readme structure
-```
-```
-fix: add the local identifier to anonymous td during retrieve and list operations
-    
-Fixes #3
-```
-
-## How to contribute with issues
-**Great Bug Reports** tend to have:
-
-- A quick summary and/or background
-- Steps to reproduce
-  - Be specific!
-  - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing
-- What you expected would happen
-- What actually happens
-- Notes (possibly including why you think this might be happening or stuff you tried that didn't work)
-
-## Code guidelines and patterns
+### Code guidelines and patterns
 
 Throughout Zion's development, we made some design decisions that we are documenting here. We encourage future developers to follow these rules to maintain a consistent code style. If you want to change this list or provide feedback, feel free to open an issue and talk about it! 
 
-### File names
+#### File names
 File names follow the NestJS convention: `${name}.${scope}.${extension}`.
 - `name` is the *kebab-case* name of the file. Example `my-component`.
 - `scope` is the *kebab-case* name of the scope. Example `controller`. 
 - `extension` The extension of the file. Example `ts`.
 
-### Function naming
+#### Function naming
 Functions that validate input MUST be prefixed with `assert`. For instance, `assertUniqueThingDescriptionId` is a function that validates if the `id` of a thing description is unique. 
 
-### Controller and Services Single Responsibility
+#### Controller and Services Single Responsibility
 Controllers MUST only contain logic that is related to the HTTP request. They can manipulate the request or response, but they MUST NOT contain any application logic. For example, a controller MUST NOT validate the payload of a request or perform database requests directly. On the other hand, services MUST NOT process requests or responses. Moreover, direct database queries MUST NOT be performed in a service.
 
 

src/introduction/td-builder.service.ts

@@ -42,8 +42,7 @@ export class ThingDescriptionBuilderService {
    * validation by including a <code>contentType</code> that is missing from the TM
    * describing the directory's API.
    *
-   * TODO: Update URL once the change has been included in the published specification.
-   * @see https://w3c.github.io/wot-discovery/#directory-api-spec
+   * @see https://www.w3.org/TR/2023/REC-wot-discovery-20231205/#directory-api-spec
    */
   private insertResponseContentType(): void {
     const actions = this.built?.actions;

src/introduction/well-known.controller.ts

@@ -10,8 +10,8 @@ import { WellKnownService } from './well-known.service';
  * It exposes the Thing Description document via `/.well-known/wot` and
  * implements the CoRE Link Format introduction method via `/.well-known/core`.
  *
- * @see https://w3c.github.io/wot-discovery/#introduction-well-known
- * @see https://w3c.github.io/wot-discovery/#introduction-core-rd-sec
+ * @see https://www.w3.org/TR/2023/REC-wot-discovery-20231205/#introduction-well-known
+ * @see https://www.w3.org/TR/2023/REC-wot-discovery-20231205/#introduction-core-rd-sec
  */
 @ApiTags('Introduction')
 @Controller('.well-known')

test/e2e/well-known.e2e-spec.ts

@@ -6,7 +6,7 @@ import { getE2ETestResources } from './../utils/resources';
 
 describe('/well-known', () => {
   /**
-   * @see https://w3c.github.io/wot-discovery/#introduction-well-known
+   * @see https://www.w3.org/TR/2023/REC-wot-discovery-20231205/#introduction-well-known
    */
   const SPECIFICATION_PATH = 'wot';
   /**
@@ -43,8 +43,8 @@ describe('/well-known', () => {
       });
 
       /**
-       * @see https://w3c.github.io/wot-discovery/#introduction-well-known
-       * @see https://w3c.github.io/wot-discovery/#exploration-self
+       * @see https://www.w3.org/TR/2023/REC-wot-discovery-20231205/#introduction-well-known
+       * @see https://www.w3.org/TR/2023/REC-wot-discovery-20231205/#exploration-server
        */
       it('should follow the specification', async () => {
         const { status, headers, data } = await axios.get(`/.well-known/${SPECIFICATION_PATH}`);
@@ -59,8 +59,8 @@ describe('/well-known', () => {
 
     describe('HEAD', () => {
       /**
-       * @see https://w3c.github.io/wot-discovery/#introduction-well-known
-       * @see https://w3c.github.io/wot-discovery/#exploration-self
+       * @see https://www.w3.org/TR/2023/REC-wot-discovery-20231205/#introduction-well-known
+       * @see https://www.w3.org/TR/2023/REC-wot-discovery-20231205/#exploration-server
        */
       it('should answer to HEAD according to specification', async () => {
         const { status, headers } = await axios.head(`/.well-known/${SPECIFICATION_PATH}`);
@@ -80,7 +80,7 @@ describe('/well-known', () => {
       });
 
       /**
-       * @see https://w3c.github.io/wot-discovery/#introduction-core-rd-sec
+       * @see https://www.w3.org/TR/2023/REC-wot-discovery-20231205/#introduction-core-rd-sec
        */
       it('should follow the specification', async () => {
         const { status, headers, data } = await axios.get(`/.well-known/${WELL_KNOWN_CORE_PATH}`);