fixed: documentation typos and omitted details from LIP

.changeset/weak-bulldogs-develop.md

@@ -0,0 +1,5 @@
+---
+'@lens-protocol/metadata': patch
+---
+
+**fixed:** documentation typos and omitted details from LIP

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;
 };

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;
 };

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;
 };

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;
 };

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;
 };

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;
 };

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;
 };

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;
 };

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;
 };

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;
 };

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;
 };

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;
 }>;

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;
 };

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;
 };

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;
 };

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;
 };

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;
 };