Skip to content

Commit

Permalink
Change schema URL to "v0" since we haven't done the 1.0 release yet
Browse files Browse the repository at this point in the history
  • Loading branch information
octogonz committed Nov 17, 2019
1 parent 4f46de1 commit d89d2c5
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 16 deletions.
6 changes: 3 additions & 3 deletions tsdoc-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ until it finds a folder containing **tsconfig.json** or **package.json**, and th
**tsdoc.json** from that location.

The **tsdoc.json** file conforms to the [tsdoc.schema.json](
https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json) JSON schema. It defines tags using
https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json) JSON schema. It defines tags using
similar fields as the
[TSDocTagDefinition](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/configuration/TSDocTagDefinition.ts)
API used by `TSDocParser` from `@microsoft/tsdoc`.
Expand All @@ -29,7 +29,7 @@ Here's a simple example:
**tsdoc.json**
```js
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"tagDefinitions": [
{
"tagName": "@myTag",
Expand All @@ -45,7 +45,7 @@ a list of paths that will be mixed in with the current file:
**tsdoc.json**
```js
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"extends": [
"my-package/dist/tsdoc-base.json",
"./path/to/local/file/tsdoc-local.json"
Expand Down
2 changes: 1 addition & 1 deletion tsdoc-config/src/TSDocConfigFile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ interface IConfigJson {
export class TSDocConfigFile {
public static readonly FILENAME: string = 'tsdoc.json';
public static readonly CURRENT_SCHEMA_URL: string
= 'https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json';
= 'https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json';

/**
* A queryable log that reports warnings and error messages that occurred during parsing.
Expand Down
12 changes: 6 additions & 6 deletions tsdoc-config/src/__tests__/TSDocConfigFile.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ test('Load p1', () => {
"filePath": "assets/p1/tsdoc.json",
"messages": Array [],
"tagDefinitions": Array [],
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
}
`);
});
Expand Down Expand Up @@ -90,7 +90,7 @@ test('Load p3', () => {
"tagNameWithUpperCase": "@BASE1",
},
],
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
},
Object {
"extendsFiles": Array [],
Expand All @@ -107,7 +107,7 @@ test('Load p3', () => {
"tagNameWithUpperCase": "@BASE2",
},
],
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
},
],
"extendsPaths": Array [
Expand All @@ -126,7 +126,7 @@ test('Load p3', () => {
"tagNameWithUpperCase": "@ROOT",
},
],
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
}
`);
});
Expand All @@ -149,7 +149,7 @@ test('Load p4', () => {
"tagNameWithUpperCase": "@EXAMPLE",
},
],
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
},
],
"extendsPaths": Array [
Expand All @@ -167,7 +167,7 @@ test('Load p4', () => {
"tagNameWithUpperCase": "@ROOT",
},
],
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"tsdocSchema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
}
`);
});
2 changes: 1 addition & 1 deletion tsdoc-config/src/__tests__/assets/p1/tsdoc.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json"
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json"
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"tagDefinitions": [
{
"tagName": "@base1",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"tagDefinitions": [
{
"tagName": "@base2",
Expand Down
2 changes: 1 addition & 1 deletion tsdoc-config/src/__tests__/assets/p3/tsdoc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"extends": [
"./base1/tsdoc-base1.json",
"./base2/tsdoc-base2.json"
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tsdoc-config/src/__tests__/assets/p4/tsdoc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v1/tsdoc.schema.json",
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"extends": [
"example-lib/dist/tsdoc-example.json"
],
Expand Down

0 comments on commit d89d2c5

Please sign in to comment.