Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update links to point to published Discovery Recommendation #70

Merged
merged 1 commit into from
Dec 18, 2023
Merged

docs: update links to point to published Discovery Recommendation #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/introduction/td-builder.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 2 additions & 2 deletions src/introduction/well-known.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
12 changes: 6 additions & 6 deletions test/e2e/well-known.e2e-spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
/**
Expand Down Expand Up @@ -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}`);
Expand All @@ -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}`);
Expand All @@ -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}`);
Expand Down