From 39005b4d73ada50385937f663a4f05fca03d40f4 Mon Sep 17 00:00:00 2001 From: Cesare Naldi Date: Mon, 4 Dec 2023 08:56:59 +0100 Subject: [PATCH] fixed: documentation typos and omitted details from LIP --- .changeset/weak-bulldogs-develop.md | 5 +++++ src/profile/ProfileMetadataSchema.ts | 2 +- src/publication/3D.ts | 2 +- src/publication/ArticleSchema.ts | 2 +- src/publication/AudioSchema.ts | 2 +- src/publication/CheckingInSchema.ts | 2 +- src/publication/EmbedSchema.ts | 2 +- src/publication/EventSchema.ts | 2 +- src/publication/ImageSchema.ts | 2 +- src/publication/LinkSchema.ts | 4 +++- src/publication/LiveStreamSchema.ts | 21 +++++++++++++++++---- src/publication/MintSchema.ts | 2 +- src/publication/MirrorMetadataSchema.ts | 2 +- src/publication/SpaceSchema.ts | 2 +- src/publication/StorySchema.ts | 2 +- src/publication/TextOnlySchema.ts | 2 +- src/publication/TransactionSchema.ts | 2 +- src/publication/VideoSchema.ts | 2 +- 18 files changed, 40 insertions(+), 20 deletions(-) create mode 100644 .changeset/weak-bulldogs-develop.md diff --git a/.changeset/weak-bulldogs-develop.md b/.changeset/weak-bulldogs-develop.md new file mode 100644 index 00000000..f96b27d9 --- /dev/null +++ b/.changeset/weak-bulldogs-develop.md @@ -0,0 +1,5 @@ +--- +'@lens-protocol/metadata': patch +--- + +**fixed:** documentation typos and omitted details from LIP diff --git a/src/profile/ProfileMetadataSchema.ts b/src/profile/ProfileMetadataSchema.ts index 1a0d921c..c822faae 100644 --- a/src/profile/ProfileMetadataSchema.ts +++ b/src/profile/ProfileMetadataSchema.ts @@ -96,7 +96,7 @@ export type ProfileMetadata = { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/3D.ts b/src/publication/3D.ts index a73bba3f..ee89e004 100644 --- a/src/publication/3D.ts +++ b/src/publication/3D.ts @@ -121,7 +121,7 @@ export type ThreeDMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/ArticleSchema.ts b/src/publication/ArticleSchema.ts index fd3c57a2..2c82d79f 100644 --- a/src/publication/ArticleSchema.ts +++ b/src/publication/ArticleSchema.ts @@ -65,7 +65,7 @@ export type ArticleMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/AudioSchema.ts b/src/publication/AudioSchema.ts index ac3a060f..4418cc29 100644 --- a/src/publication/AudioSchema.ts +++ b/src/publication/AudioSchema.ts @@ -76,7 +76,7 @@ export type AudioMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/CheckingInSchema.ts b/src/publication/CheckingInSchema.ts index 545189bc..89045526 100644 --- a/src/publication/CheckingInSchema.ts +++ b/src/publication/CheckingInSchema.ts @@ -85,7 +85,7 @@ export type CheckingInMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/EmbedSchema.ts b/src/publication/EmbedSchema.ts index 6f193317..ae556ed3 100644 --- a/src/publication/EmbedSchema.ts +++ b/src/publication/EmbedSchema.ts @@ -67,7 +67,7 @@ export type EmbedMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/EventSchema.ts b/src/publication/EventSchema.ts index c83d2af5..5100f0b3 100644 --- a/src/publication/EventSchema.ts +++ b/src/publication/EventSchema.ts @@ -172,7 +172,7 @@ export type EventMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/ImageSchema.ts b/src/publication/ImageSchema.ts index fdb11290..d7a51c3a 100644 --- a/src/publication/ImageSchema.ts +++ b/src/publication/ImageSchema.ts @@ -76,7 +76,7 @@ export type ImageMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/LinkSchema.ts b/src/publication/LinkSchema.ts index a254c73a..07806360 100644 --- a/src/publication/LinkSchema.ts +++ b/src/publication/LinkSchema.ts @@ -65,7 +65,9 @@ export type LinkMetadata = MarketplaceMetadata & { */ lens: LinkMetadataDetails; /** - * The signature. + * A cryptographic signature of the `lens` data. + * + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/LiveStreamSchema.ts b/src/publication/LiveStreamSchema.ts index 7d5714db..97deb806 100644 --- a/src/publication/LiveStreamSchema.ts +++ b/src/publication/LiveStreamSchema.ts @@ -51,6 +51,21 @@ export type LiveStreamMetadataDetails = PublicationMetadataCommon & { liveUrl: EncryptableURI; /** * The data cannot be changed so you can put in an API endpoint to know if it is still live or not for clients to be able to check. + * + * Responses from this endpoint should conform to the following schema: + * + * ```json + * { + * "$schema": "http://json-schema.org/draft-07/schema#", + * "type": "object", + * "properties": { + * "isLive": { + * "type": "boolean" + * } + * }, + * "required": ["isLive"] + * } + * ``` */ checkLiveAPI?: EncryptableURI; /** @@ -113,10 +128,8 @@ export type LiveStreamMetadata = MarketplaceMetadata & { lens: LiveStreamMetadataDetails; /** * A cryptographic signature of the `lens` data. - * - * @experimental DO NOT use ye - -@experimental DO NOT use yet + * + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/MintSchema.ts b/src/publication/MintSchema.ts index b2f56938..fd49fa70 100644 --- a/src/publication/MintSchema.ts +++ b/src/publication/MintSchema.ts @@ -78,7 +78,7 @@ export type MintMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/MirrorMetadataSchema.ts b/src/publication/MirrorMetadataSchema.ts index 5b83f391..2d9e6987 100644 --- a/src/publication/MirrorMetadataSchema.ts +++ b/src/publication/MirrorMetadataSchema.ts @@ -52,7 +52,7 @@ export type MirrorMetadata = ShapeCheck<{ /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }>; diff --git a/src/publication/SpaceSchema.ts b/src/publication/SpaceSchema.ts index 6424de34..20ceb5ea 100644 --- a/src/publication/SpaceSchema.ts +++ b/src/publication/SpaceSchema.ts @@ -84,7 +84,7 @@ export type SpaceMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/StorySchema.ts b/src/publication/StorySchema.ts index abd645fb..8b4563e6 100644 --- a/src/publication/StorySchema.ts +++ b/src/publication/StorySchema.ts @@ -52,7 +52,7 @@ export type StoryMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/TextOnlySchema.ts b/src/publication/TextOnlySchema.ts index 7db260ef..e64b1517 100644 --- a/src/publication/TextOnlySchema.ts +++ b/src/publication/TextOnlySchema.ts @@ -46,7 +46,7 @@ export type TextOnlyMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/TransactionSchema.ts b/src/publication/TransactionSchema.ts index e91dea3c..c92168e3 100644 --- a/src/publication/TransactionSchema.ts +++ b/src/publication/TransactionSchema.ts @@ -93,7 +93,7 @@ export type TransactionMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; }; diff --git a/src/publication/VideoSchema.ts b/src/publication/VideoSchema.ts index e665b2d3..15f83170 100644 --- a/src/publication/VideoSchema.ts +++ b/src/publication/VideoSchema.ts @@ -79,7 +79,7 @@ export type VideoMetadata = MarketplaceMetadata & { /** * A cryptographic signature of the `lens` data. * - * @experimental DO NOT use ye + * @experimental DO NOT use yet */ signature?: Signature; };