Editing API Schemas

When adding a new API to the unified schema, you must edit the schema to make sure that none of the types in your current schema conflict with existing types in the unified schema. Each type in the unified schema must be unique.

You don’t have to perform edit functions before you add an API schema to the unified schema. You can make changes to an API schema even after you’ve added it to the unified schema. However, if Anypoint DataGraph raises any conflict errors, you must edit your schema to resolve those conflicts before adding it to the unified schema.

If you add an API source using the CLI, you cannot edit it or update its version directly in the UI. You must make these changes using the CLI.

To edit an API schema, address the following tasks where applicable:

Resolve any conflicts between object types

If there are types that have a conflict with the unified schema, make sure to resolve them all. See Resolving Conflicts and Merge Inconsistencies for more information.
Enable collaboration on an object type

Enable collaboration for applicable types and provide the required settings. This step is optional, but when you enable collaboration on types, you’ll create a more connected and enriched unified schema. Refer to Enabling Object Type Collaboration in Anypoint DataGraph for more information.
Manage visibility of schema elements

You can hide the fields, types, or query methods that you don’t want to have visible in the unified schema. Refer to Schema Element Visibility in Anypoint DataGraph for more information.
Review and edit names of schema elements

You can review or change the names of all fields, types, and query methods that you are adding to the unified schema. Refer to Editing Names of Schema Elements for more information.
Merge similar object types

Merging types enables you to combine similar types to extend their fields and datasets for a more enriched query result. Refer to How Object Type Merges Work in Anypoint DataGraph for more information.
Link related fields between object types

Linking enables you to join related fields from two types for a more enriched query result. Refer to How Links Between Object Types Work in Anypoint DataGraph for more information.
Edit an API URL

If you need to edit the URL of an API that you’ve added to the unified schema, you can do so on the API details page. Refer to Edit the URL for an API Added to the Unified Schema.
Change the Authentication Method for an API

If you need to edit the authentication method of an API that you’ve added to the unified schema, you can do so on the API details page. Refer to Change the Authentication Method for an API Added to the Unified Schema.
Configure mutual authentication (mTLS) for an API

If you need to configure mTLS for an API that you’ve added to the unified schema, you can do so on the API details page. Refer to Configure mTLS for an API Added to the Unified Schema.
Update an API version

After you’ve added an API schema to DataGraph, you can update the version of the API source any time you like. Refer to Update an API Version.