Manage operations

Console

To add a new API operation to an API version, do the following:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub
2. Click APIs.
3. Locate the API you wish to add an operation to. Use Filter to specify keywords to filter the list of APIs. If needed, use Search to locate an API.
4. Click the API to view its details.
5. Click the Versions tab and select the version you wish to add from the Select a version drop-down list.
6. Go to the Operations section, click Add operation.
7. Specify operation details in the Add operation form.
   • Operation ID: Click Specify Unique ID to optionally provide a unique ID for the operation. If you omit the ID, API hub creates one for you.
   • Documentation: Enter the URL to documentation for the API operation.
   • Description: Add a description of the operation.
   • Operation type: This field is automatically set as HTTP.
   • Deprecated: Select if the operation is deprecated.
   • Path: Enter the path of the operation.
   • Path description: Enter the description of the path of the operation.
   • Method: Enter the method of the operation.
   • Additional attributes: Add user-defined attributes based on your organizational or team needs. See User attributes.
8. Click Create.

REST

To add a new API operation using the Create operations API, use the following command:

  curl --location --request POST 
  'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID/operations?api_operation_id=OPERATION_ID' \
--header 'Authorization: Bearer $(gcloud auth print-access-token)' \
--header 'Content-Type: application/json' \
--data '{
    "details":{
         "description":"DESCRIPTION",
         "deprecated":false,
        "documentation":{
                "external_uri":"EXTERNAL_URI"
            },
        "http_operation":{
            "method":"METHOD",
            "path":{
                "path":"PATH",
                "description":"DESCRIPTION"
            }
        }
    }
}'

Replace the following:

• HUB_PROJECT: The project ID of the API hub project.
• HUB_LOCATION: The location of the API hub project.
• API_ID: The ID of the API.
• VERSION_ID: The ID of the API version.
• OPERATION_ID: The ID of the API operation.
• DESCRIPTION: The description of the API operation.
• EXTERNAL_URI: The external URI of the API operation.
• METHOD: The method of the API operation.
• PATH: The path of the API operation.

Example:

  curl --location --request POST 
  'https://apihub.googleapis.com/v1/projects/test-project/locations/us-central1/apis/test-api/versions/version-id/operations?api_operation_id=test-operation' \
  --header 'Authorization: Bearer $(gcloud auth print-access-token)' \
  --header 'Content-Type: application/json' \
  --data '{
      "details":{
           "description":"api to create root level entity api in apihub",
           "deprecated":false,
          "documentation":{
                  "external_uri":"https://google.com"
              },
          "http_operation":{
              "method":"POST",
              "path":{
                  "path":"/apis",
                  "description":"It is ccfe managed resource"
              }
          }
      }
  }'
  

Console

To edit an API operation, do the following:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub
2. Click APIs.
3. Locate the API with the version that contains the operation you wish to edit. Use Filter to specify keywords to filter the list of APIs. If needed, use Search to locate an API.
4. Click the API to view its details.
5. Click the Versions tab and select the version that contains the operation you wish to edit.
6. Go to the Operations section and locate the operation you wish to edit.
7. Select Edit from the Actions menu in the row of the operation you wish to edit.
8. In the Edit operation form, make the required changes to the operation details.
9. Click Save.

REST

To edit or update an API operation using the Patch operations API, use the following command:

  curl --location --request PATCH 'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID/operations/OPERATION_ID?update_mask=UPDATE_MASK' \
  --header 'Authorization: Bearer $(gcloud auth print-access-token)' \
  --data '{
      "details":{
           "description":"DESCRIPTION",
           "deprecated":false,
          "documentation":{
                  "external_uri":"EXTERNAL_URI"
              },
          "http_operation":{
              "method":"METHOD",
              "path":{
                  "path":"PATH",
                  "description":"DESCRIPTION"
              }
          }
      }
  }'
  

Replace the following:

• HUB_PROJECT: The project ID of the API hub project.
• HUB_LOCATION: The location of the API hub project.
• API_ID: The ID of the API.
• VERSION_ID: The ID of the API version.
• OPERATION_ID: The ID of the API operation.
• UPDATE_MASK: The update mask of the API operation.
• DESCRIPTION: The description of the API operation.
• EXTERNAL_URI: The external URI of the API operation.
• PATH: The path of the API operation.

Example:

  curl --location --request PATCH 
  'https://apihub.googleapis.com/v1/projects/test-project/locations/us-central1/apis/test-api/versions/version-id/operations/test-operation?update_mask=details.http_operation.path' \
--header 'Authorization: Bearer $(gcloud auth print-access-token)' \
--data '{
    "details":{
         "description":"api to create root level entity api in apihub update",
         "deprecated":false,
        "documentation":{
                "external_uri":"https://google.com"
            },
        "http_operation":{
            "method":"POST",
            "path":{
                "path":"/apiss",
                "description":"It is ccfe managed api"
            }
        }
    }
}'

Console

To delete an API operation, do the following:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub
2. Click APIs.
3. Locate the API with the version that contains the operation you wish to delete. Use Filter to specify keywords to filter the list of APIs. If needed, use Search to locate an API.
4. Click the API to view its details.
5. Click the Versions tab and select the version that contains the operation you wish to delete.
6. Go to the Operations section and locate the operation you wish to delete.
7. Select Delete from the Actions menu in the row of the operation you wish to delete.
8. Click Delete in the confirmation dialog.

REST

To delete an API operation using the Delete operations API, use the following command:

  curl --location --request DELETE 'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID/operations/OPERATION_ID' \
  --header 'Authorization: Bearer $(gcloud auth print-access-token)'

Replace the following:

• HUB_PROJECT: The project ID of the API hub project.
• HUB_LOCATION: The location of the API hub project.
• API_ID: The ID of the API.
• VERSION_ID: The ID of the API version.
• OPERATION_ID: The ID of the API operation.

Example:

  curl --location --request DELETE 'https://apihub.googleapis.com/v1/projects/test-project/locations/us-central1/apis/test-api/versions/version-id/operations/test-operation' \
  --header 'Authorization: Bearer $(gcloud auth print-access-token)'

Console

To view the API operations of an API version, do the following:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub
2. Click APIs.
3. Locate the API you wish to inspect. Use Filter to specify keywords to filter the list of APIs. If needed, use Search to locate an API.
4. Select an API.
5. Go to the Versions tables in the API details page.
6. Select an API version.
7. The API operations for the selected API version are listed in the Operations table on the page.

REST

To list the API operations of an API version, use the following command:

  curl -H "Authorization: Bearer $(gcloud auth print-access-token)"  -X GET  
  https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID/operations

Replace the following:

• HUB_PROJECT: The project ID of the API hub project.
• HUB_LOCATION: The location of the API hub project.
• API_ID: The ID of the API.
• VERSION_ID: The ID of the API version.

Example:

  curl -H "Authorization: Bearer $(gcloud auth print-access-token)"  -X GET  
  https://apihub.googleapis.com/v1/projects/test-project/locations/us-central1/apis/test-api/versions/version-id/operations

REST

To get the details of an API operation, use the following command:

  curl -H "Authorization: Bearer $(gcloud auth print-access-token)"  -X GET  https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID/operations/OPERATION_ID

Replace the following:

• HUB_PROJECT: The project ID of the API hub project.
• HUB_LOCATION: The location of the API hub project.
• API_ID: The ID of the API.
• VERSION_ID: The ID of the API version.
• OPERATION_ID: The ID of the API operation.

Example:

  curl -H "Authorization: Bearer $(gcloud auth print-access-token)"  -X GET  https://apihub.googleapis.com/v1/projects/test-project/locations/us-central1/apis/test-api/versions/version-id/operations/test-operation