Fix yard urls

lineofflight · Oct 4, 2024 · b15ee2b · b15ee2b
1 parent b303eab
commit b15ee2b
Show file tree

Hide file tree

Showing 14 changed files with 88 additions and 86 deletions.
diff --git a/lib/generator/formatter.rb b/lib/generator/formatter.rb
@@ -50,7 +50,7 @@ def convert_doc_links_to_full_url(text)
         path = Regexp.last_match(2)
         url = "https://developer-docs.amazon.com/sp-api/docs/#{path}"
 
-        "{#{link_text} #{url}}"
+        "{#{url} #{link_text}}"
       end
     end
 
@@ -59,7 +59,7 @@ def convert_html_links_to_yard(text)
         url = Regexp.last_match(1)
         link_text = Regexp.last_match(2)
 
-        "{#{link_text} #{url}}"
+        "{#{url} #{link_text}}"
       end
     end
   end

diff --git a/lib/peddler/api/amazon_warehousing_and_distribution_2024_05_09.rb b/lib/peddler/api/amazon_warehousing_and_distribution_2024_05_09.rb
@@ -41,9 +41,9 @@ def get_inbound_shipment(shipment_id, sku_quantities: nil, rate_limit: 2.0)
       #   sorted in DESCENDING order.
       # @param shipment_status [String] Filter by inbound shipment status.
       # @param updated_after [String] List the inbound shipments that were updated after a certain time (inclusive). The
-      #   date must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format.
+      #   date must be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
       # @param updated_before [String] List the inbound shipments that were updated before a certain time (inclusive).
-      #   The date must be in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} format.
+      #   The date must be in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} format.
       # @param max_results [Integer] Maximum number of results to return.
       # @param next_token [String] Token to retrieve the next set of paginated results.
       # @param rate_limit [Float] Requests per second

diff --git a/lib/peddler/api/catalog_items_2020_12_01.rb b/lib/peddler/api/catalog_items_2020_12_01.rb
@@ -13,8 +13,9 @@ class API
     # Selling Partner API for Catalog Items
     #
     # The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon
-    # catalog. For more information, see the {Catalog Items API Use Case Guide
-    # https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2020-12-01-use-case-guide}.
+    # catalog. For more information, see the
+    # {https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2020-12-01-use-case-guide Catalog Items API Use
+    # Case Guide}.
     class CatalogItems20201201 < API
       # Search for and return a list of Amazon catalog items and associated information.
       #

diff --git a/lib/peddler/api/catalog_items_2022_04_01.rb b/lib/peddler/api/catalog_items_2022_04_01.rb
@@ -13,8 +13,9 @@ class API
     # Selling Partner API for Catalog Items
     #
     # The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon
-    # catalog. For more information, refer to the {Catalog Items API Use Case Guide
-    # https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide}.
+    # catalog. For more information, refer to the
+    # {https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide Catalog Items API Use
+    # Case Guide}.
     class CatalogItems20220401 < API
       # Search for and return a list of Amazon catalog items and associated information either by identifier or by
       # keywords.

diff --git a/lib/peddler/api/catalog_items_v0.rb b/lib/peddler/api/catalog_items_v0.rb
@@ -17,11 +17,11 @@ class API
     class CatalogItemsV0 < API
       # Effective September 30, 2022, the `listCatalogItems` operation will no longer be available in the Selling
       # Partner API for Catalog Items v0. As an alternative, `searchCatalogItems` is available in the latest version of
-      # the {Selling Partner API for Catalog Items v2022-04-01
-      # https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference}. Integrations that rely
-      # on the `listCatalogItems` operation should migrate to the `searchCatalogItems`operation to avoid service
-      # disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated
-      # and you can continue to make calls to it.
+      # the {https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference Selling Partner API
+      # for Catalog Items v2022-04-01}. Integrations that rely on the `listCatalogItems` operation should migrate to the
+      # `searchCatalogItems`operation to avoid service disruption. _Note:_ The
+      # [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to
+      # make calls to it.
       #
       # @note This operation can make a static sandbox call.
       # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for which items are returned.
@@ -59,12 +59,11 @@ def list_catalog_items(marketplace_id, query: nil, query_context_id: nil, seller
       end
 
       # Effective September 30, 2022, the `getCatalogItem` operation will no longer be available in the Selling Partner
-      # API for Catalog Items v0. This operation is available in the latest version of the {Selling Partner API for
-      # Catalog Items v2022-04-01
-      # https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference}. Integrations that rely
-      # on this operation should migrate to the latest version to avoid service disruption. _Note:_ The
-      # [`listCatalogCategories`](#get-catalogv0categories) operation is not being deprecated and you can continue to
-      # make calls to it.
+      # API for Catalog Items v0. This operation is available in the latest version of the
+      # {https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference Selling Partner API for
+      # Catalog Items v2022-04-01}. Integrations that rely on this operation should migrate to the latest version to
+      # avoid service disruption. _Note:_ The [`listCatalogCategories`](#get-catalogv0categories) operation is not being
+      # deprecated and you can continue to make calls to it.
       #
       # @note This operation can make a static sandbox call.
       # @param marketplace_id [String] A marketplace identifier. Specifies the marketplace for the item.

diff --git a/lib/peddler/api/easy_ship_2022_03_23.rb b/lib/peddler/api/easy_ship_2022_03_23.rb
@@ -15,17 +15,17 @@ class API
     # The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy
     # Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for
     # delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the
-    # {Marketplace Support Table
-    # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table}
-    # for the differences in Easy Ship operations by marketplace.
+    # {https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table
+    # Marketplace Support Table} for the differences in Easy Ship operations by marketplace.
     class EasyShip20220323 < API
       # Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions
       # that the seller specifies. This operation is available for scheduled and unscheduled orders based on marketplace
-      # support. See **Get Time Slots** in the {Marketplace Support Table
-      # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table}.
-      # This operation can return time slots that have either pickup or drop-off handover methods - see **Supported
-      # Handover Methods** in the {Marketplace Support Table
-      # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table}.
+      # support. See **Get Time Slots** in the
+      # {https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table
+      # Marketplace Support Table}. This operation can return time slots that have either pickup or drop-off handover
+      # methods - see **Supported Handover Methods** in the
+      # {https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table
+      # Marketplace Support Table}.
       #
       # @note This operation can make a static sandbox call.
       # @param list_handover_slots_request [Hash] The request schema for the `listHandoverSlots` operation.
@@ -60,14 +60,13 @@ def get_scheduled_package(amazon_order_id, marketplace_id, rate_limit: 1.0)
       # Schedules an Easy Ship order and returns the scheduled package information. This operation does the following: *
       # Specifies the time slot and handover method for the order to be scheduled for delivery. * Updates the Easy Ship
       # order status. * Generates a shipping label and an invoice. Calling `createScheduledPackage` also generates a
-      # warranty document if you specify a `SerialNumber` value. To get these documents, see {How to get invoice,
-      # shipping label, and warranty documents
-      # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide}. * Shows the status of
-      # Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and examine the
-      # `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and
-      # **Warranty** columns in the {Marketplace Support Table
-      # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table}
-      # to see which documents are supported in each marketplace.
+      # warranty document if you specify a `SerialNumber` value. To get these documents, see
+      # {https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide How to get invoice,
+      # shipping label, and warranty documents}. * Shows the status of Easy Ship orders when you call the `getOrders`
+      # operation of the Selling Partner API for Orders and examine the `EasyShipShipmentStatus` property in the
+      # response body. See the **Shipping Label**, **Invoice**, and **Warranty** columns in the
+      # {https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table
+      # Marketplace Support Table} to see which documents are supported in each marketplace.
       #
       # @note This operation can make a static sandbox call.
       # @param create_scheduled_package_request [Hash] The request schema for the `createScheduledPackage` operation.
@@ -82,9 +81,9 @@ def create_scheduled_package(create_scheduled_package_request, rate_limit: 1.0)
 
       # Updates the time slot for handing over the package indicated by the specified `scheduledPackageId`. You can get
       # the new `slotId` value for the time slot by calling the `listHandoverSlots` operation before making another
-      # `patch` call. See the **Update Package** column in the {Marketplace Support Table
-      # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table}
-      # to see which marketplaces this operation is supported in.
+      # `patch` call. See the **Update Package** column in the
+      # {https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table
+      # Marketplace Support Table} to see which marketplaces this operation is supported in.
       #
       # @note This operation can make a static sandbox call.
       # @param update_scheduled_packages_request [Hash] The request schema for the `updateScheduledPackages` operation.
@@ -99,18 +98,18 @@ def update_scheduled_packages(update_scheduled_packages_request: nil, rate_limit
 
       # This operation automatically schedules a time slot for all the `amazonOrderId`s given as input, generating the
       # associated shipping labels, along with other compliance documents according to the marketplace (refer to the
-      # {marketplace document support table
-      # https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table}).
-      # Developers calling this operation may optionally assign a `packageDetails` object, allowing them to input a
-      # preferred time slot for each order in ther request. In this case, Amazon will try to schedule the respective
-      # packages using their optional settings. On the other hand, *i.e.*, if the time slot is not provided, Amazon will
-      # then pick the earliest time slot possible. Regarding the shipping label's file format, external developers are
-      # able to choose between PDF or ZPL, and Amazon will create the label accordingly. This operation returns an array
-      # composed of the scheduled packages, and a short-lived URL pointing to a zip file containing the generated
-      # shipping labels and the other documents enabled for your marketplace. If at least an order couldn't be
-      # scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an entry for each order
-      # we couldn't process. Each entry is composed of an error message describing the reason of the failure, so that
-      # sellers can take action. The table below displays the supported request and burst maximum rates:
+      # {https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table
+      # marketplace document support table}). Developers calling this operation may optionally assign a `packageDetails`
+      # object, allowing them to input a preferred time slot for each order in ther request. In this case, Amazon will
+      # try to schedule the respective packages using their optional settings. On the other hand, *i.e.*, if the time
+      # slot is not provided, Amazon will then pick the earliest time slot possible. Regarding the shipping label's file
+      # format, external developers are able to choose between PDF or ZPL, and Amazon will create the label accordingly.
+      # This operation returns an array composed of the scheduled packages, and a short-lived URL pointing to a zip file
+      # containing the generated shipping labels and the other documents enabled for your marketplace. If at least an
+      # order couldn't be scheduled, then Amazon adds the `rejectedOrders` list into the response, which contains an
+      # entry for each order we couldn't process. Each entry is composed of an error message describing the reason of
+      # the failure, so that sellers can take action. The table below displays the supported request and burst maximum
+      # rates:
       #
       # @note This operation can make a static sandbox call.
       # @param create_scheduled_packages_request [Hash] The request schema for the `createScheduledPackageBulk`

diff --git a/lib/peddler/api/listings_items_2020_09_01.rb b/lib/peddler/api/listings_items_2020_09_01.rb
@@ -15,8 +15,8 @@ class API
     # The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner
     # listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which
     # you use to retrieve the information about Amazon product types needed to use the Listings Items API. For more
-    # information, see the {Listing Items API Use Case Guide
-    # https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2020-09-01-use-case-guide}.
+    # information, see the {https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2020-09-01-use-case-guide
+    # Listing Items API Use Case Guide}.
     class ListingsItems20200901 < API
       # Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may
       # contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when

diff --git a/lib/peddler/api/listings_restrictions_2021_08_01.rb b/lib/peddler/api/listings_restrictions_2021_08_01.rb
@@ -13,8 +13,9 @@ class API
     # Selling Partner API for Listings Restrictions
     #
     # The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog
-    # listings. For more information, see the {Listings Restrictions API Use Case Guide
-    # https://developer-docs.amazon.com/sp-api/docs/listings-restrictions-api-v2021-08-01-use-case-guide}.
+    # listings. For more information, see the
+    # {https://developer-docs.amazon.com/sp-api/docs/listings-restrictions-api-v2021-08-01-use-case-guide Listings
+    # Restrictions API Use Case Guide}.
     class ListingsRestrictions20210801 < API
       # Returns listing restrictions for an item in the Amazon Catalog.
       #

diff --git a/lib/peddler/api/product_type_definitions_2020_09_01.rb b/lib/peddler/api/product_type_definitions_2020_09_01.rb
@@ -16,8 +16,8 @@ class API
     # requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type
     # that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the
     # Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds). For
-    # more information, see the {Product Type Definitions API Use Case Guide
-    # https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide}.
+    # more information, see the {https://developer-docs.amazon.com/sp-api/docs/product-type-api-use-case-guide Product
+    # Type Definitions API Use Case Guide}.
     class ProductTypeDefinitions20200901 < API
       # Search for and return a list of Amazon product types that have definitions available.
       #

diff --git a/lib/peddler/api/reports_2021_06_30.rb b/lib/peddler/api/reports_2021_06_30.rb
@@ -27,10 +27,10 @@ class Reports20210630 < API
       #   returned will match at least one of the marketplaces that you specify.
       # @param page_size [Integer] The maximum number of reports to return in a single call.
       # @param created_since [String] The earliest report creation date and time for reports to include in the response,
-      #   in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} date time format. The default is 90 days
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} date time format. The default is 90 days
       #   ago. Reports are retained for a maximum of 90 days.
       # @param created_until [String] The latest report creation date and time for reports to include in the response,
-      #   in {ISO 8601 https://developer-docs.amazon.com/sp-api/docs/iso-8601} date time format. The default is now.
+      #   in {https://developer-docs.amazon.com/sp-api/docs/iso-8601 ISO 8601} date time format. The default is now.
       # @param next_token [String] A string token returned in the response to your previous request. `nextToken` is
       #   returned when the number of results exceeds the specified `pageSize` value. To get the next page of results,
       #   call the `getReports` operation and include this token as the only parameter. Specifying `nextToken` with any

diff --git a/lib/peddler/api/shipment_invoicing_v0.rb b/lib/peddler/api/shipment_invoicing_v0.rb
@@ -19,8 +19,9 @@ class ShipmentInvoicingV0 < API
       #
       # @note This operation can make a static sandbox call.
       # @param shipment_id [String] The identifier for the shipment. Get this value from the FBAOutboundShipmentStatus
-      #   notification. For information about subscribing to notifications, see the {Notifications API Use Case Guide
-      #   https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide}.
+      #   notification. For information about subscribing to notifications, see the
+      #   {https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide Notifications API Use Case
+      #   Guide}.
       # @param rate_limit [Float] Requests per second
       # @return [Hash] The API response
       def get_shipment_details(shipment_id, rate_limit: 1.133)

diff --git a/lib/peddler/api/tokens_2021_03_01.rb b/lib/peddler/api/tokens_2021_03_01.rb
@@ -15,8 +15,8 @@ class API
     # The Selling Partner API for Tokens provides a secure way to access a customer's PII (Personally Identifiable
     # Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted
     # resources that you specify. The RDT authorizes subsequent calls to restricted operations that correspond to the
-    # restricted resources that you specified. For more information, see the {Tokens API Use Case Guide
-    # https://developer-docs.amazon.com/sp-api/docs/tokens-api-use-case-guide}.
+    # restricted resources that you specified. For more information, see the
+    # {https://developer-docs.amazon.com/sp-api/docs/tokens-api-use-case-guide Tokens API Use Case Guide}.
     class Tokens20210301 < API
       # Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted
       # resource is the HTTP method and path from a restricted operation that returns Personally Identifiable