Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using the API menu reorg #989

Merged
merged 4 commits into from
Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/configure/portal/developers.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: "Enable deprecations"
description: "Get ahead of upcoming deprecations in the Portal"
createdAt: "2022-09-05T15:58:36.027Z"
updatedAt: "2022-12-09T13:03:30.599Z"
sidebar_label: "Early deprecations"
---

:::note Access to Codat Developers
Expand Down
1 change: 1 addition & 0 deletions docs/using-the-api/authentication.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Authenticate"
description: "Use your auth header or API key to authenticate with Codat's APIs"
sidebar_label: "API keys"
---

API keys are tokens used to control access to the API. Codat expects the API key to be included in all requests to the server, Base64 encoded within an 'Authorization' header:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Implementing client-side data storage"
title: "Implementing local data storage"
description: "Tips and advice on storing, working with, and consuming Codat data"
sidebar_label: "Client-side data storage"
sidebar_label: "Local data storage"

---
You can store JSON data retrieved from the Codat API in many different ways. We have described some of the options for you, but the right choice depends on your requirements and the tools and skillset you have available.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Implementing an account mapping user interface"
description: "Tips and advice on managing inconsistent accounts across your user base"
sidebar_label: "Account mapping user interface"
sidebar_label: "Mapping interface"
---

Accounting platforms that your customers use normally offer them a default set of accounts (also known as chart of accounts), pre-defined to match accounting best practices. Your customers then have the ability to rename and renumber these accounts, or create new ones, to match their business needs.
Expand Down
4 changes: 1 addition & 3 deletions docs/using-the-api/modified-dates.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: "Using modified dates"
title: "Use modified dates"
description: "Understanding when data has been modified"
createdAt: "2022-11-07T19:53:44.472Z"
updatedAt: "2022-11-28T13:03:19.120Z"
---

Codat surfaces two dates to indicate when data was last updated:
Expand Down
2 changes: 1 addition & 1 deletion docs/using-the-api/optimizing-api-calls.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Optimizing API calls"
title: "Optimize API calls"
description: "Learn how to use our APIs efficiently and ensure you are not reaching our rate limits"
---

Expand Down
4 changes: 1 addition & 3 deletions docs/using-the-api/ordering-results.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: "Ordering results"
title: "Order results"
description: "Basics and examples of ordering in Codat's APIs"
createdAt: "2020-02-27T01:32:43.041Z"
updatedAt: "2022-11-07T20:00:50.251Z"
---

In addition to [queries](/using-the-api/querying), you can limit response data using the `orderBy` parameter to specify the ordering of records in the response.
Expand Down
37 changes: 15 additions & 22 deletions sidebars/use-the-api.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ module.exports = [
"using-the-api/paging",
"using-the-api/ordering-results",
"using-the-api/modified-dates",
{
type: "category",
label: "Supplemental data",
collapsed: true,
items: [
"using-the-api/supplemental-data/overview",
"using-the-api/supplemental-data/usecases",
],
},
"using-the-api/custom-data",
],
},
{
Expand All @@ -33,7 +43,6 @@ module.exports = [
"configure/portal/pull-and-push-history",
],
},
"using-the-api/testing",
{
type: "category",
label: "Webhooks",
Expand All @@ -48,33 +57,17 @@ module.exports = [
},
{
type: "category",
label: "Supplemental data",
label: "Tips and guidance",
collapsed: true,
items: [
"using-the-api/supplemental-data/overview",
"using-the-api/supplemental-data/usecases",
],
},
"using-the-api/custom-data",
{
type: "category",
label: "Best practices",
collapsed: true,
items: [
"using-the-api/best-practices/implementing-a-mapping-page",
"using-the-api/best-practices/client-side-data-storage",
],
},
{
type: "category",
label: "Troubleshooting",
collapsed: true,
items: [
"using-the-api/errors",
"using-the-api/rate-limits",
"using-the-api/optimizing-api-calls",
"using-the-api/testing",
"using-the-api/best-practices/implementing-a-mapping-page",
"using-the-api/best-practices/client-side-data-storage",
],
},
"using-the-api/errors",
{
type: "category",
label: "Change management",
Expand Down
Loading