refactor: clean up verbiage in other plain client docs

contentful · Sep 20, 2023 · a783e51 · a783e51
1 parent dcca72e
commit a783e51
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/lib/plain/entities/app-action.ts b/lib/plain/entities/app-action.ts
@@ -10,7 +10,7 @@ import { OptionalDefaults } from '../wrappers/wrap'
 
 export type AppActionPlainClientAPI = {
   /**
-   * Fetches the given App Action.
+   * Fetches the App Action
    * @param params entity IDs to identify the App Action
    * @returns the App Action
    * @throws if the request fails, or the App Action is not found
@@ -57,7 +57,7 @@ export type AppActionPlainClientAPI = {
     params: OptionalDefaults<GetAppActionsForEnvParams & QueryParams>
   ): Promise<CollectionProp<AppActionProps>>
   /**
-   * Deletes the given App Action
+   * Deletes the App Action
    * @param params entity IDs to identify the App Action to delete
    * @returns void
    * @throws if the request fails, or the App Action is not found

diff --git a/lib/plain/entities/app-bundle.ts b/lib/plain/entities/app-bundle.ts
@@ -9,7 +9,7 @@ import { OptionalDefaults } from '../wrappers/wrap'
 
 export type AppBundlePlainClientAPI = {
   /**
-   * Fetches the given App Bundle
+   * Fetches the App Bundle
    * @param params entity IDs to identify the App Bundle
    * @returns the App Bundle
    * @throws if the request fails, or the App Bundle is not found
@@ -39,7 +39,7 @@ export type AppBundlePlainClientAPI = {
     params: OptionalDefaults<GetAppDefinitionParams & QueryParams>
   ): Promise<CollectionProp<AppBundleProps>>
   /**
-   * Deletes the given App Bundle
+   * Deletes the App Bundle
    * @param params entity IDs to identify the App Bundle
    * @throws if the request fails, or the App Bundle is not found
    * @example

diff --git a/lib/plain/entities/app-details.ts b/lib/plain/entities/app-details.ts
@@ -4,7 +4,7 @@ import { OptionalDefaults } from '../wrappers/wrap'
 
 export type AppDetailsPlainClientAPI = {
   /**
-   * Upserts an App Detail
+   * Creates or updates an App Detail
    * @param params entity IDs to identify the App Definition or App Details
    * @param payload the App Detail upsert
    * @returns the updated App Detail and its metadata
@@ -31,7 +31,7 @@ export type AppDetailsPlainClientAPI = {
     payload: CreateAppDetailsProps
   ): Promise<AppDetailsProps>
   /**
-   * Fetches the requested App Detail
+   * Fetches the App Detail
    * @param params entity IDs to identify the App Detail
    * @returns the App Detail
    * @throws if the request fails, or the App Detail is not found
@@ -45,7 +45,7 @@ export type AppDetailsPlainClientAPI = {
    */
   get(params: OptionalDefaults<GetAppDefinitionParams>): Promise<AppDetailsProps>
   /**
-   * Fetches the given App Detail
+   * Fetches the App Detail
    * @param params entity IDs to identify the App Detail
    * @throws if the request fails, or the App Detail is not found
    * @example

diff --git a/lib/plain/entities/app-upload.ts b/lib/plain/entities/app-upload.ts
@@ -5,7 +5,7 @@ import { OptionalDefaults } from '../wrappers/wrap'
 
 export type AppUploadPlainClientAPI = {
   /**
-   * Fetches the given App Upload
+   * Fetches the App Upload
    * @param params entity IDs to identify the App Upload
    * @returns the App Upload
    * @throws if the request fails, or the App Upload is not found
@@ -19,7 +19,7 @@ export type AppUploadPlainClientAPI = {
    */
   get(params: OptionalDefaults<GetAppUploadParams>): Promise<AppUploadProps>
   /**
-   * Deletes the given App Upload
+   * Deletes the App Upload
    * @param params entity IDs to identify the App Upload
    * @throws if the request fails, or the App Upload is not found
    * @example
@@ -33,7 +33,7 @@ export type AppUploadPlainClientAPI = {
   delete(params: OptionalDefaults<GetAppUploadParams>): Promise<void>
   /**
    * Creates an App Upload
-   * @param params entity IDs to identify the Organization to create the App Upload in
+   * @param params entity IDs to identify the Organization to upload the App to
    * @param payload the App Upload
    * @returns the App Upload
    * @throws if the request fails, or the Organization is not found