Deleting a Page Descriptor

How to delete a page descriptor manually or via GraphQL

There are two methods for deleting a Page Descriptor in Aurora: a GraphQL mutation and manually using the Git repository. In this guide, we will go over each of them.

GraphQL Method

To delete one or more Page descriptors via GraphQL, you'll need to make a GraphQL call to execute the removeBulkPage mutation. Behind the scenes, this mutation will remove the page's JSON file and check them into the Git repository for you.

Example

Here is an example GraphQL call, which includes the Query and the Variables to make the call:

Query

GraphQL removeBulkPage mutation

mutation removeBulkPage($pageIds:[String!]!) {
  removeBulkPage(pageIds: $pageIds) {
    result
    errors {
      __typename
      ... on PageNotFoundError {
        ... Error
        pageId
      }
    }
  }
}
fragment Error on Error {
    message
    fields
}

In this example, we're naming variables that identify the page descriptors we would like to delete. Page Descriptors are identified by their pageIds.

Variables

GraphQL removeBulkPage mutation variables

{
  "pageIds": [
    "ForumBoardPage",
    "BlogBoardPage"
  ]
}

Using Variables we have identified two Page Descriptors we want to delete.

Manual Method

To delete a Page override manually, you need to remove the .page.json file for the specific Page you are deleting and commit the change to your Git repository.