Skip to content

Commit

Permalink
feat: move GraphQL docs to deprecated folder
Browse files Browse the repository at this point in the history
  • Loading branch information
@christian-konrad
christian-konrad committed Mar 22, 2024
1 parent 4413aa1 commit fc10616
Show file tree
Hide file tree
Showing 3 changed files with 156 additions and 141 deletions.
8 changes: 4 additions & 4 deletions docs/apis-tools/tasklist-api/tasklist-api-overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ sidebar_position: 1
description: "Build apps powered by BPMN that require human interaction, and make requests."
---

In this document, we'll go over the basics on how to consume the Tasklist GraphQL API. Read more about how to build a real world application [here](../tasklist-api-tutorial). Be sure to [authenticate to use the Tasklist API](./tasklist-api-authentication.md).
Learn the basics on how to consume the Tasklist GraphQL API. Read more about how to build a real world application [here](../tasklist-api-tutorial). Be sure to [authenticate to use the Tasklist API](./tasklist-api-authentication.md).

:::note
Review the new [Tasklist REST API](../tasklist-api-rest/tasklist-api-rest-overview.md). This API offers the same functionality as the current GraphQL API, but with a more streamlined and efficient way of interacting with our service.
:::info
The GraphQL API is deprecated. To ensure a smooth transition, we'll continue to support our GraphQL API for a period of time, giving you an opportunity to migrate to the new REST API version at your own pace.

The GraphQL API will be deprecated in the near future. To ensure a smooth transition, we'll continue to support our GraphQL API for a period of time, giving you an opportunity to migrate to the new REST API version at your own pace. We will provide further details on the timeline and process for this migration soon.
Review the [Tasklist REST API](../tasklist-api-rest/tasklist-api-rest-overview.md). The REST API offers more functionality as the GraphQL API and a more streamlined and efficient way of interacting with our service.
:::

## Endpoint
Expand Down
283 changes: 147 additions & 136 deletions optimize_sidebars.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1413,141 +1413,6 @@ module.exports = {
"apis-tools/optimize-api/variable-labeling",
],
},
{
"Tasklist API (GraphQL)": [
docsLink("Schema Documentation", "apis-tools/tasklist-api/"),
docsLink(
"Overview",
"apis-tools/tasklist-api/tasklist-api-overview/"
),
docsLink(
"Authentication",
"apis-tools/tasklist-api/tasklist-api-authentication/"
),
docsLink(
"Tutorial",
"apis-tools/tasklist-api/tasklist-api-tutorial/"
),
docsLink(
"GraphQL to REST API migration",
"apis-tools/tasklist-api/tasklist-api-graphql-to-rest-migration/"
),

{
Directives: [
docsLink(
"deprecated",
"apis-tools/tasklist-api/directives/deprecated/"
),
docsLink(
"include",
"apis-tools/tasklist-api/directives/include/"
),
docsLink("skip", "apis-tools/tasklist-api/directives/skip/"),
docsLink(
"specifiedBy",
"apis-tools/tasklist-api/directives/specified-by/"
),
],
},
{
Enums: [
docsLink("Sort", "apis-tools/tasklist-api/enums/sort/"),
docsLink(
"TaskSortFields",
"apis-tools/tasklist-api/enums/task-sort-fields/"
),
docsLink(
"TaskState",
"apis-tools/tasklist-api/enums/task-state/"
),
],
},
{
Inputs: [
docsLink(
"DateFilter",
"apis-tools/tasklist-api/inputs/date-filter-input/"
),
docsLink(
"TaskOrderBy",
"apis-tools/tasklist-api/inputs/task-order-by/"
),
docsLink(
"TaskQuery",
"apis-tools/tasklist-api/inputs/task-query/"
),
docsLink(
"VariableInput",
"apis-tools/tasklist-api/inputs/variable-input/"
),
],
},
{
Mutations: [
docsLink(
"claimTask",
"apis-tools/tasklist-api/mutations/claim-task/"
),
docsLink(
"completeTask",
"apis-tools/tasklist-api/mutations/complete-task/"
),
docsLink(
"deleteProcessInstance",
"apis-tools/tasklist-api/mutations/delete-process-instance/"
),
docsLink(
"unclaimTask",
"apis-tools/tasklist-api/mutations/unclaim-task/"
),
],
},
{
Objects: [
docsLink("Form", "apis-tools/tasklist-api/objects/form/"),
docsLink("Task", "apis-tools/tasklist-api/objects/task/"),
docsLink("User", "apis-tools/tasklist-api/objects/user/"),
docsLink(
"Variable",
"apis-tools/tasklist-api/objects/variable/"
),
],
},
{
Queries: [
docsLink(
"currentUser",
"apis-tools/tasklist-api/queries/current-user/"
),
docsLink("form", "apis-tools/tasklist-api/queries/form/"),
docsLink("task", "apis-tools/tasklist-api/queries/task/"),
docsLink("tasks", "apis-tools/tasklist-api/queries/tasks/"),
docsLink(
"variable",
"apis-tools/tasklist-api/queries/variable/"
),
docsLink(
"variables",
"apis-tools/tasklist-api/queries/variables/"
),
],
},
{
Scalars: [
docsLink(
"DateTime",
"apis-tools/tasklist-api/scalars/datetime/"
),
docsLink("Boolean", "apis-tools/tasklist-api/scalars/boolean/"),
docsLink("ID", "apis-tools/tasklist-api/scalars/id/"),
docsLink("Int", "apis-tools/tasklist-api/scalars/int/"),
docsLink("String", "apis-tools/tasklist-api/scalars/string/"),
],
},
],
},

{
"Tasklist API (REST)": [
docsLink(
Expand All @@ -1568,7 +1433,6 @@ module.exports = {
),
],
},

{
"Web Modeler API (REST)": [
docsLink("Overview", "apis-tools/web-modeler-api/overview/"),
Expand All @@ -1595,6 +1459,153 @@ module.exports = {
),
],
},
{
Deprecated: [
{
"Tasklist API (GraphQL)": [
docsLink("Schema Documentation", "apis-tools/tasklist-api/"),
docsLink(
"Overview",
"apis-tools/tasklist-api/tasklist-api-overview/"
),
docsLink(
"Authentication",
"apis-tools/tasklist-api/tasklist-api-authentication/"
),
docsLink(
"Tutorial",
"apis-tools/tasklist-api/tasklist-api-tutorial/"
),
docsLink(
"GraphQL to REST API migration",
"apis-tools/tasklist-api/tasklist-api-graphql-to-rest-migration/"
),

{
Directives: [
docsLink(
"deprecated",
"apis-tools/tasklist-api/directives/deprecated/"
),
docsLink(
"include",
"apis-tools/tasklist-api/directives/include/"
),
docsLink(
"skip",
"apis-tools/tasklist-api/directives/skip/"
),
docsLink(
"specifiedBy",
"apis-tools/tasklist-api/directives/specified-by/"
),
],
},
{
Enums: [
docsLink("Sort", "apis-tools/tasklist-api/enums/sort/"),
docsLink(
"TaskSortFields",
"apis-tools/tasklist-api/enums/task-sort-fields/"
),
docsLink(
"TaskState",
"apis-tools/tasklist-api/enums/task-state/"
),
],
},
{
Inputs: [
docsLink(
"DateFilter",
"apis-tools/tasklist-api/inputs/date-filter-input/"
),
docsLink(
"TaskOrderBy",
"apis-tools/tasklist-api/inputs/task-order-by/"
),
docsLink(
"TaskQuery",
"apis-tools/tasklist-api/inputs/task-query/"
),
docsLink(
"VariableInput",
"apis-tools/tasklist-api/inputs/variable-input/"
),
],
},
{
Mutations: [
docsLink(
"claimTask",
"apis-tools/tasklist-api/mutations/claim-task/"
),
docsLink(
"completeTask",
"apis-tools/tasklist-api/mutations/complete-task/"
),
docsLink(
"deleteProcessInstance",
"apis-tools/tasklist-api/mutations/delete-process-instance/"
),
docsLink(
"unclaimTask",
"apis-tools/tasklist-api/mutations/unclaim-task/"
),
],
},
{
Objects: [
docsLink("Form", "apis-tools/tasklist-api/objects/form/"),
docsLink("Task", "apis-tools/tasklist-api/objects/task/"),
docsLink("User", "apis-tools/tasklist-api/objects/user/"),
docsLink(
"Variable",
"apis-tools/tasklist-api/objects/variable/"
),
],
},
{
Queries: [
docsLink(
"currentUser",
"apis-tools/tasklist-api/queries/current-user/"
),
docsLink("form", "apis-tools/tasklist-api/queries/form/"),
docsLink("task", "apis-tools/tasklist-api/queries/task/"),
docsLink("tasks", "apis-tools/tasklist-api/queries/tasks/"),
docsLink(
"variable",
"apis-tools/tasklist-api/queries/variable/"
),
docsLink(
"variables",
"apis-tools/tasklist-api/queries/variables/"
),
],
},
{
Scalars: [
docsLink(
"DateTime",
"apis-tools/tasklist-api/scalars/datetime/"
),
docsLink(
"Boolean",
"apis-tools/tasklist-api/scalars/boolean/"
),
docsLink("ID", "apis-tools/tasklist-api/scalars/id/"),
docsLink("Int", "apis-tools/tasklist-api/scalars/int/"),
docsLink(
"String",
"apis-tools/tasklist-api/scalars/string/"
),
],
},
],
},
],
},
],
},

Expand Down
6 changes: 5 additions & 1 deletion sidebars.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -713,10 +713,14 @@ module.exports = {
),
],
},
require("./docs/apis-tools/tasklist-api/sidebar-schema"),
require("./docs/apis-tools/tasklist-api-rest/sidebar-schema"),
require("./docs/apis-tools/web-modeler-api/sidebar-schema"),
require("./docs/apis-tools/zeebe-api/sidebar-schema"),
{
Deprecated: [
require("./docs/apis-tools/tasklist-api/sidebar-schema"),
],
},
],
},
{
Expand Down

0 comments on commit fc10616

Please sign in to comment.