Merge pull request #70 from JKRhb/update-docs

docs: update links to point to published Discovery Recommendation
vaimee · Dec 18, 2023 · 99bc2eb · 99bc2eb
2 parents 5b03e3e + 703e6ca
commit 99bc2eb
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 10 deletions.
diff --git a/src/introduction/td-builder.service.ts b/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;

diff --git a/src/introduction/well-known.controller.ts b/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')

diff --git a/test/e2e/well-known.e2e-spec.ts b/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}`);