Manage attributes

Console

To view all the system attributes, in the Google Cloud console, go to the API Hub > Settings page. You can view all the existing system attributes in the System attributes tab.

REST API

To view all the system attributes of a resource issue a GET request to the following API:

For more information about the API, see ListAttributes.

The following example shows the API call to get the system attributes for all the resources.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-type: application/json" \
-X GET \
https://apihub.googleapis.com/v1/projects/test-project-1/locations/us-central1/attributes?filter=definition_type=SYSTEM_DEFINED

Console

To add a value for a system attribute, do the following steps:

1. In the Google Cloud console, go to the API Hub > Settings page.

   This displays all the existing system attributes in the System attributes section of the Attributes tab.

2. Click Edit for the attribute to which you want add a value.

   This opens the attribute's edit pane, which displays the existing attribute values.

3. To add a new value, click Add item, and then enter the new value you want to add.
4. Click Save.

REST API

To update allowed values of a system defined attribute of Enum datatype, issue a PATCH request to the following API:

For more information about the API, see UpdateAttribute.

The following example shows the API call to update the values of the Business unit attribute.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"allowed_values": [
{
"id": "bu1",
"display_name": "Business unit 1",
"description": "The API can be used by business unit 1"
},
{
"id": "bu2",
"display_name": "Business unit 2",
"description": "The API can be used by business unit 2"
},
{
"id": "bu3",
"display_name": "Business unit 3",
"description": "The API can be used by business unit 3"
}]}' \
-X PATCH https://apihub.googleapis.com/v1/projects/test-15/locations/us-central1/attributes/system-business-unit?update_mask=allowed_values 

It's important to understand how API hub interprets the request payload for the UpdateAttribute API.

• If the value you specify in the payload is already present, API hub checks if the value has been updated in the payload, and then overwrites the value if it's updated.
• If the value isn't available in the payload, API hub interprets that value should be deleted, and deletes the value from API hub.
• If a new value is available in the payload, API hub adds the new value to the attribute.

Console

To view all the user defined attributes, in the Google Cloud console, go to the API Hub > Settings page. You can view all the user defined attributes in the User defined attributes section of the Attributes tab.

REST API

To view all the user defined attributes of a resource issue a GET request to the following API:

For more information about the API, see ListAttributes.

The following example shows the API call to get the user attributes for the API resource.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-type: application/json" \
-X GET \
https://apihub.googleapis.com/v1/projects/test-project-1/locations/us-central1/attributes?filter=definition_type=USER_DEFINED

Console

To add a new user defined attribute, do the following steps:

1. In the Google Cloud console, go to the API Hub > Settings page.

   This displays all the user defined attributes in the User attributes section of the Attributes tab.

2. Click Create attribute.

   This opens the Add a new attribute pane.

3. Enter the following details:
   • ID: Enter an unique identifier for the attribute.
     • If you leave the field empty, API hub automatically generates an unique ID for you.
     • If you manually want to enter a value, ensure that the value is unique across all the attributes.
   • Name: Enter a name for the attribute.
   • Description: Optionally, enter a attribute description.
   • Maximum allowed values: Enter a number from 1 through 20. This setting specifies the maximum number of values that the attribute can have.
   • Resource type: Select a resource type.
   • Data type: Choose the data type for the attribute. Data types include String, Enum, and JSON. If the Enum data type is selected, click + Add item, and enter the allowed values for the attribute.
4. Click Create.

REST API

To add a new user defined attribute, issue a POST request to the following API:

For more information about the API, see CreateAttribute.

The following example shows the API call to create the attribute-01 user defined attribute.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json"  \
-d '{
"display_name" : "custom attribute",
"description" : "custom attribute details",
"definition_type" : "USER_DEFINED",
"scope" : "API",
"data_type" : "ENUM",
"allowed_values" : [
{
"id" : "value-1",
"display_name" : "Value 1",
"description" : "Value 1 test description",
"immutable" : false,
},
{
"id" : "value-2",
"display_name" : "Value 2",
"description" : "Value 2 test description",
"immutable" : false,
},
],
"cardinality" : 4,
"mandatory" : false
}' \
-X POST  https://apihub.googleapis.com/v1/projects/test-15/locations/us-central1/attributes?attribute_id=attribute-01

Console

To edit a user defined attribute, do the following steps:

1. In the Google Cloud console, go to the API Hub > Settings page.

   This displays all the existing user defined attributes in the User attributes section of the Attributes tab.

2. Click Edit for the attribute you want to edit.

   This opens the attribute's edit pane, which displays the existing attribute values.

3. You can edit the name, description, and maximum allowed values. For Enum types, you can add new values. To add a new value for an Enum type, click Add item, and then enter the new value you want to add.
4. Click Save.

REST API

To edit a user defined attribute, issue a PATCH request to the following API:

For more information about the API, see UpdateAttribute.

The following example shows the API call update the API Visibility user defined attribute.

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -d '{"name": "projects/test-15/locations/us-central1/attributes/API Visibility",
    display_name" : "API Visibility Updated", "allowedValues": [
    {
    "id": "internal",
    "displayName": "Internal",
    "description": "The API is visible internally in an organization"
    },
    {
    "id": "external",
    "displayName": "External",
    "description": "The API is visible externally in an organization"
    },
    {
    "id": "public",
    "displayName": "Public",
    "description": "The API is visible public in an organization"
    }
    ]}' \
    -X PATCH https://autopush-apihub.sandbox.googleapis.com/v1/projects/common-dev-15/locations/us-central1/attributes/API Visibility?update_mask=display_name,allowed_values
    

It's important to understand how API hub interprets the request payload for the UpdateAttribute API.

• If the value you specify in the payload is already present, API hub checks if the value has been updated in the payload, and then overwrites the value if it's updated.
• If the value isn't available in the payload, API hub interprets that value should be deleted, and deletes the value from API hub.
• If a new value is available in the payload, API hub adds the new value to the attribute.