Updated docs

modio · Oct 27, 2024 · 4b1d017 · 4b1d017
1 parent 958dad3
commit 4b1d017
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 14 deletions.
diff --git a/source/changelog/index.html.md b/source/changelog/index.html.md
@@ -1,21 +1,25 @@
 # API Versions
 
 ## v1 (latest version)
-### Date Updated: August 15, 2023, 3:59 pm GMT
+### Date Updated: October 26, 2024, 8:19 am GMT
 
 Initial API Release.
 
-### <span class="versionwrap">[View v1 docs](/)</span>
+### <span class="versionwrap">[View v1 docs](../)</span>
 
 # Changelog
 
+### Jan 16, 2024 - Migrating API domain
+
+Beginning Jan 1st, 2025, usage of the old API domain of **api.mod.io** will heavily restricted, and all API usage should be using the new API domain **https://*.modapi.io/v1** which can be found via your games dashboard or on your [API access page](--parse_siteurl/me/access).
+
 ### Oct 1, 2023 - Adding new rate limit error ref
 
-Beginning Jan 1st, 2024, the error ref **11009** will be returned when a rate limit applies only to the endpoint being called. Error ref **11008** will continue to be returned in all other scenarios where the [rate limit](/#rate-limiting) applies to all endpoints.
+Beginning Jan 1st, 2024, the error ref **11009** will be returned when a rate limit applies only to the endpoint being called. Error ref **11008** will continue to be returned in all other scenarios where the [rate limit](/restapi/rate-limiting/) applies to all endpoints.
 
 ### Oct 27, 2022 - Deprecating X-Ratelimit headers
 
-Beginning Nov 20th, 2022, all custom rate limit headers `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-RetryAfter` will no longer be returned. They will be replaced with `retry-after` when the [ratelimit is exceeded](/#rate-limiting).
+Beginning Nov 20th, 2022, all custom rate limit headers `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-RetryAfter` will no longer be returned. They will be replaced with `retry-after` when the [ratelimit is exceeded](/restapi/rate-limiting/).
 
 # How We Version
 
@@ -52,7 +56,7 @@ part of the URL required to make a successful request.
 When making requests to the API, you need to be sure you know what functionality is available to you
 and what you can expect the API to do under every situation. With that said, and in the interest of
 being as explicit as possible if you supply a version in the URL of your request that is _not_ listed
-in the [changelog](#api-versions) below - a `404 Not Found` will be returned in the form of the [Error Object](/#error-object).
+in the [changelog](#api-versions) below - a `404 Not Found` will be returned in the form of the [Error Object](/restapiref/#error-object).
 
 ## What are breaking changes
 

diff --git a/source/includes/_changelog.md b/source/includes/_changelog.md
@@ -2,13 +2,17 @@
 
 # Changelog
 
+### Jan 16, 2024 - Migrating API domain
+
+Beginning Jan 1st, 2025, usage of the old API domain of **api.mod.io** will heavily restricted, and all API usage should be using the new API domain **--parse_apiurl** which can be found via your games dashboard or on your [API access page](--parse_siteurl/me/access).
+
 ### Oct 1, 2023 - Adding new rate limit error ref
 
-Beginning Jan 1st, 2024, the error ref **--parse_errorref_RATE_LIMITED_ENDPOINT** will be returned when a rate limit applies only to the endpoint being called. Error ref **--parse_errorref_RATE_LIMITED_GLOBAL** will continue to be returned in all other scenarios where the [rate limit](../#rate-limiting) applies to all endpoints.
+Beginning Jan 1st, 2024, the error ref **--parse_errorref_RATE_LIMITED_ENDPOINT** will be returned when a rate limit applies only to the endpoint being called. Error ref **--parse_errorref_RATE_LIMITED_GLOBAL** will continue to be returned in all other scenarios where the [rate limit](/restapi/rate-limiting/) applies to all endpoints.
 
 ### Oct 27, 2022 - Deprecating X-Ratelimit headers
 
-Beginning Nov 20th, 2022, all custom rate limit headers `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-RetryAfter` will no longer be returned. They will be replaced with `retry-after` when the [ratelimit is exceeded](../#rate-limiting).
+Beginning Nov 20th, 2022, all custom rate limit headers `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-RetryAfter` will no longer be returned. They will be replaced with `retry-after` when the [ratelimit is exceeded](/restapi/rate-limiting/).
 
 # How We Version
 
@@ -45,7 +49,7 @@ part of the URL required to make a successful request.
 When making requests to the API, you need to be sure you know what functionality is available to you
 and what you can expect the API to do under every situation. With that said, and in the interest of
 being as explicit as possible if you supply a version in the URL of your request that is _not_ listed
-in the [changelog](#api-versions) below - a `404 Not Found` will be returned in the form of the [Error Object](../#error-object).
+in the [changelog](#api-versions) below - a `404 Not Found` will be returned in the form of the [Error Object](/restapiref/#error-object).
 
 ## What are breaking changes
 

diff --git a/source/index.html.md b/source/index.html.md
@@ -11858,6 +11858,7 @@ Add mod dependencies required by the corresponding mod. A dependency is a mod th
     Parameter|Type|Required|Description
     ---|---|---|---|
     dependencies[]|integer|true|One or more mod IDs that this mod is dependent on. Every dependency to add requires a separate field with dependencies[] as the key (eg. dependencies[]=1, dependencies[]=2). Max of 5 dependencies per request.
+    sync|integer|false|If true, will remove all existing dependencies and replace with the new ones provided in the request (if any).
 
 > Example response
 
@@ -15267,7 +15268,7 @@ Status|Meaning|Error Ref|Description|Response Schema
 To perform this request, you must be authenticated via one of the following methods:
 <a href="#authentication">OAuth 2</a> (Scopes: write)
 </aside>
-## Purchase A Mod
+## Purchase A Mod (External)
 
 > Example request
 
@@ -15524,7 +15525,7 @@ Purchase a mod. A Successful request will return the newly created [Pay Object](
 }
 
 ```
-<h3 id="Purchase-A-Mod-responses">Responses</h3>
+<h3 id="Purchase-A-Mod-(External)-responses">Responses</h3>
 
 Status|Meaning|Error Ref|Description|Response Schema
 ---|---|----|---|---|
@@ -15961,7 +15962,7 @@ Status|Meaning|Error Ref|Description|Response Schema
 To perform this request, you must be authenticated via one of the following methods:
 <a href="#authentication">OAuth 2</a> (Scopes: writemonetization)
 </aside>
-## Transaction Commit
+## S2S Transaction Commit
 
 > Example request
 
@@ -16098,7 +16099,7 @@ Create a service-to-service (S2S) transaction commit. This is for performing an
 }
 
 ```
-<h3 id="Transaction-Commit-responses">Responses</h3>
+<h3 id="S2S-Transaction-Commit-responses">Responses</h3>
 
 Status|Meaning|Error Ref|Description|Response Schema
 ---|---|----|---|---|
@@ -16107,7 +16108,7 @@ Status|Meaning|Error Ref|Description|Response Schema
 To perform this request, you must be authenticated via one of the following methods:
 <a href="#authentication">OAuth 2</a> (Scopes: writemonetization)
 </aside>
-## Transaction Clawback
+## S2S Transaction Clawback
 
 > Example request
 
@@ -16250,7 +16251,7 @@ Create a service-to-service (S2S) transaction clawback. This is for unwinding a
 }
 
 ```
-<h3 id="Transaction-Clawback-responses">Responses</h3>
+<h3 id="S2S-Transaction-Clawback-responses">Responses</h3>
 
 Status|Meaning|Error Ref|Description|Response Schema
 ---|---|----|---|---|