Index
ApiHub
(interface)ApiHubDependencies
(interface)ApiHubPlugin
(interface)HostProjectRegistrationService
(interface)LintingService
(interface)Provisioning
(interface)RuntimeProjectAttachmentService
(interface)Api
(message)ApiHubInstance
(message)ApiHubInstance.Config
(message)ApiHubInstance.Config.EncryptionType
(enum)ApiHubInstance.State
(enum)ApiHubResource
(message)ApiOperation
(message)Attribute
(message)Attribute.AllowedValue
(message)Attribute.DataType
(enum)Attribute.DefinitionType
(enum)Attribute.Scope
(enum)AttributeValues
(message)AttributeValues.EnumAttributeValues
(message)AttributeValues.StringAttributeValues
(message)CreateApiHubInstanceRequest
(message)CreateApiRequest
(message)CreateAttributeRequest
(message)CreateDependencyRequest
(message)CreateDeploymentRequest
(message)CreateExternalApiRequest
(message)CreateHostProjectRegistrationRequest
(message)CreateRuntimeProjectAttachmentRequest
(message)CreateSpecRequest
(message)CreateVersionRequest
(message)Definition
(message)Definition.Type
(enum)DeleteApiRequest
(message)DeleteAttributeRequest
(message)DeleteDependencyRequest
(message)DeleteDeploymentRequest
(message)DeleteExternalApiRequest
(message)DeleteRuntimeProjectAttachmentRequest
(message)DeleteSpecRequest
(message)DeleteVersionRequest
(message)Dependency
(message)Dependency.DiscoveryMode
(enum)Dependency.State
(enum)DependencyEntityReference
(message)DependencyErrorDetail
(message)DependencyErrorDetail.Error
(enum)Deployment
(message)DisablePluginRequest
(message)Documentation
(message)EnablePluginRequest
(message)ExternalApi
(message)GetApiHubInstanceRequest
(message)GetApiOperationRequest
(message)GetApiRequest
(message)GetAttributeRequest
(message)GetDefinitionRequest
(message)GetDependencyRequest
(message)GetDeploymentRequest
(message)GetExternalApiRequest
(message)GetHostProjectRegistrationRequest
(message)GetPluginRequest
(message)GetRuntimeProjectAttachmentRequest
(message)GetSpecContentsRequest
(message)GetSpecRequest
(message)GetStyleGuideContentsRequest
(message)GetStyleGuideRequest
(message)GetVersionRequest
(message)HostProjectRegistration
(message)HttpOperation
(message)HttpOperation.Method
(enum)Issue
(message)LintResponse
(message)LintResponse.SummaryEntry
(message)LintSpecRequest
(message)LintState
(enum)Linter
(enum)ListApiOperationsRequest
(message)ListApiOperationsResponse
(message)ListApisRequest
(message)ListApisResponse
(message)ListAttributesRequest
(message)ListAttributesResponse
(message)ListDependenciesRequest
(message)ListDependenciesResponse
(message)ListDeploymentsRequest
(message)ListDeploymentsResponse
(message)ListExternalApisRequest
(message)ListExternalApisResponse
(message)ListHostProjectRegistrationsRequest
(message)ListHostProjectRegistrationsResponse
(message)ListRuntimeProjectAttachmentsRequest
(message)ListRuntimeProjectAttachmentsResponse
(message)ListSpecsRequest
(message)ListSpecsResponse
(message)ListVersionsRequest
(message)ListVersionsResponse
(message)LookupApiHubInstanceRequest
(message)LookupApiHubInstanceResponse
(message)LookupRuntimeProjectAttachmentRequest
(message)LookupRuntimeProjectAttachmentResponse
(message)OpenApiSpecDetails
(message)OpenApiSpecDetails.Format
(enum)OperationDetails
(message)OperationMetadata
(message)Owner
(message)Path
(message)Plugin
(message)Plugin.State
(enum)Point
(message)Range
(message)RuntimeProjectAttachment
(message)Schema
(message)SearchResourcesRequest
(message)SearchResourcesResponse
(message)SearchResult
(message)Severity
(enum)Spec
(message)Spec.ParsingMode
(enum)SpecContents
(message)SpecDetails
(message)StyleGuide
(message)StyleGuideContents
(message)UpdateApiRequest
(message)UpdateAttributeRequest
(message)UpdateDependencyRequest
(message)UpdateDeploymentRequest
(message)UpdateExternalApiRequest
(message)UpdateSpecRequest
(message)UpdateStyleGuideRequest
(message)UpdateVersionRequest
(message)Version
(message)
ApiHub
This service provides all methods related to the API hub.
CreateApi |
---|
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
|
CreateAttribute |
---|
Create a user defined attribute. Certain pre defined attributes are already created by the API hub. These attributes will have type as
|
CreateDeployment |
---|
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
|
CreateExternalApi |
---|
Create an External API resource in the API hub.
|
CreateSpec |
---|
Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the In order to access the information parsed from the spec, use the
|
CreateVersion |
---|
Create an API version for an API resource in the API hub.
|
DeleteApi |
---|
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
|
DeleteAttribute |
---|
Delete an attribute. Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
|
DeleteDeployment |
---|
Delete a deployment resource in the API hub.
|
DeleteExternalApi |
---|
Delete an External API resource in the API hub.
|
DeleteSpec |
---|
Delete a spec. Deleting a spec will also delete the associated operations from the version.
|
DeleteVersion |
---|
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
|
GetApi |
---|
Get API resource details including the API versions contained in it.
|
GetApiOperation |
---|
Get details about a particular operation in API version.
|
GetAttribute |
---|
Get details about the attribute.
|
GetDefinition |
---|
Get details about a definition in an API version.
|
GetDeployment |
---|
Get details about a deployment and the API versions linked to it.
|
GetExternalApi |
---|
Get details about an External API resource in the API hub.
|
GetSpec |
---|
Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use
|
GetSpecContents |
---|
Get spec contents.
|
GetVersion |
---|
Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
|
ListApiOperations |
---|
List operations in an API version.
|
ListApis |
---|
List API resources in the API hub.
|
ListAttributes |
---|
List all attributes.
|
ListDeployments |
---|
List deployment resources in the API hub.
|
ListExternalApis |
---|
List External API resources in the API hub.
|
ListSpecs |
---|
List specs corresponding to a particular API resource.
|
ListVersions |
---|
List API versions of an API resource in the API hub.
|
SearchResources |
---|
Search across API-Hub resources.
|
UpdateApi |
---|
Update an API resource in the API hub. The following fields in the [API][] can be updated:
The Updating the owner field requires complete owner message and updates both owner and email fields.
|
UpdateAttribute |
---|
Update the attribute. The following fields in the
The
|
UpdateDeployment |
---|
Update a deployment resource in the API hub. The following fields in the
The
|
UpdateExternalApi |
---|
Update an External API resource in the API hub. The following fields can be updated: The
|
UpdateSpec |
---|
Update spec. The following fields in the In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The
|
UpdateVersion |
---|
Update API version. The following fields in the The
|
ApiHubDependencies
This service provides methods for various operations related to a Dependency
in the API hub.
CreateDependency |
---|
Create a dependency between two entities in the API hub.
|
DeleteDependency |
---|
Delete the dependency resource.
|
GetDependency |
---|
Get details about a dependency resource in the API hub.
|
ListDependencies |
---|
List dependencies based on the provided filter and pagination parameters.
|
UpdateDependency |
---|
Update a dependency based on the The following fields in the
|
ApiHubPlugin
This service is used for managing plugins inside the API Hub.
DisablePlugin |
---|
Disables a plugin. The
|
EnablePlugin |
---|
Enables a plugin. The
|
GetPlugin |
---|
Get details about an API Hub plugin.
|
HostProjectRegistrationService
This service is used for managing the host project registrations.
CreateHostProjectRegistration |
---|
Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.
|
GetHostProjectRegistration |
---|
Get a host project registration.
|
ListHostProjectRegistrations |
---|
Lists host project registrations.
|
LintingService
This service provides all methods related to the 1p Linter.
GetStyleGuide |
---|
Get the style guide being used for linting.
|
GetStyleGuideContents |
---|
Get the contents of the style guide.
|
LintSpec |
---|
Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.
|
UpdateStyleGuide |
---|
Update the styleGuide to be used for liniting in by API hub.
|
Provisioning
This service is used for managing the data plane provisioning of the API hub.
CreateApiHubInstance |
---|
Provisions instance resources for the API Hub.
|
GetApiHubInstance |
---|
Gets details of a single API Hub instance.
|
LookupApiHubInstance |
---|
Looks up an Api Hub instance in a given Google Cloud project. There will always be only one Api Hub instance for a Google Cloud project across all locations.
|
RuntimeProjectAttachmentService
This service is used for managing the runtime project attachments.
CreateRuntimeProjectAttachment |
---|
Attaches a runtime project to the host project.
|
DeleteRuntimeProjectAttachment |
---|
Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.
|
GetRuntimeProjectAttachment |
---|
Gets a runtime project attachment.
|
ListRuntimeProjectAttachments |
---|
List runtime projects attached to the host project.
|
LookupRuntimeProjectAttachment |
---|
Look up a runtime project attachment. This API can be called in the context of any project.
|
Api
An API resource in the API Hub.
Fields | |
---|---|
name |
Identifier. The name of the API resource in the API Hub. Format: |
display_name |
Required. The display name of the API resource. |
description |
Optional. The description of the API resource. |
documentation |
Optional. The documentation for the API resource. |
owner |
Optional. Owner details for the API resource. |
versions[] |
Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is |
create_time |
Output only. The time at which the API resource was created. |
update_time |
Output only. The time at which the API resource was last updated. |
target_user |
Optional. The target users for the API. This maps to the following system defined attribute: |
team |
Optional. The team owning the API. This maps to the following system defined attribute: |
business_unit |
Optional. The business unit owning the API. This maps to the following system defined attribute: |
maturity_level |
Optional. The maturity level of the API. This maps to the following system defined attribute: |
attributes |
Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: |
api_style |
Optional. The style of the API. This maps to the following system defined attribute: |
selected_version |
Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is |
ApiHubInstance
An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.
Fields | |
---|---|
name |
Identifier. Format: |
create_time |
Output only. Creation timestamp. |
update_time |
Output only. Last update timestamp. |
state |
Output only. The current state of the ApiHub instance. |
state_message |
Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is |
config |
Required. Config of the ApiHub instance. |
labels |
Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
description |
Optional. Description of the ApiHub instance. |
Config
Available configurations to provision an ApiHub Instance.
Fields | |
---|---|
cmek_key_name |
Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of |
encryption_type |
Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used. |
EncryptionType
Types of data encryption.
Enums | |
---|---|
ENCRYPTION_TYPE_UNSPECIFIED |
Encryption type unspecified. |
GMEK |
Default encryption using Google managed encryption key. |
CMEK |
Encryption using customer managed encryption key. |
State
State of the ApiHub Instance.
Enums | |
---|---|
STATE_UNSPECIFIED |
The default value. This value is used if the state is omitted. |
INACTIVE |
The ApiHub instance has not been initialized or has been deleted. |
CREATING |
The ApiHub instance is being created. |
ACTIVE |
The ApiHub instance has been created and is ready for use. |
UPDATING |
The ApiHub instance is being updated. |
DELETING |
The ApiHub instance is being deleted. |
FAILED |
The ApiHub instance encountered an error during a state change. |
ApiHubResource
ApiHubResource is one of the resources such as Api, Operation, Deployment, Definition, Spec and Version resources stored in API-Hub.
Fields | |
---|---|
Union field
|
|
api |
This represents Api resource in search results. Only name, display_name, description and owner fields are populated in search results. |
operation |
This represents ApiOperation resource in search results. Only name, description, spec and details fields are populated in search results. |
deployment |
This represents Deployment resource in search results. Only name, display_name, description, deployment_type and api_versions fields are populated in search results. |
spec |
This represents Spec resource in search results. Only name, display_name, description, spec_type and documentation fields are populated in search results. |
definition |
This represents Definition resource in search results. Only name field is populated in search results. |
version |
This represents Version resource in search results. Only name, display_name, description, lifecycle, compliance and accreditation fields are populated in search results. |
ApiOperation
Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec.
Fields | |
---|---|
name |
Identifier. The name of the operation. Format: |
spec |
Output only. The name of the spec from where the operation was parsed. Format is |
details |
Output only. Operation details. |
create_time |
Output only. The time at which the operation was created. |
update_time |
Output only. The time at which the operation was last updated. |
attributes |
Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: |
Attribute
An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.
Fields | |
---|---|
name |
Identifier. The name of the attribute in the API Hub. Format: |
display_name |
Required. The display name of the attribute. |
description |
Optional. The description of the attribute. |
definition_type |
Output only. The definition type of the attribute. |
scope |
Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked. |
data_type |
Required. The type of the data of the attribute. |
allowed_values[] |
Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000. |
cardinality |
Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute. |
mandatory |
Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory. |
create_time |
Output only. The time at which the attribute was created. |
update_time |
Output only. The time at which the attribute was last updated. |
AllowedValue
The value that can be assigned to the attribute when the data type is enum.
Fields | |
---|---|
id |
Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
display_name |
Required. The display name of the allowed value. |
description |
Optional. The detailed description of the allowed value. |
immutable |
Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
DataType
Enumeration of attribute's data type.
Enums | |
---|---|
DATA_TYPE_UNSPECIFIED |
Attribute data type unspecified. |
ENUM |
Attribute's value is of type enum. |
JSON |
Attribute's value is of type json. |
STRING |
Attribute's value is of type string. |
DefinitionType
Enumeration of attribute definition types.
Enums | |
---|---|
DEFINITION_TYPE_UNSPECIFIED |
Attribute definition type unspecified. |
SYSTEM_DEFINED |
The attribute is predefined by the API Hub. Note that only the list of allowed values can be updated in this case via UpdateAttribute method. |
USER_DEFINED |
The attribute is defined by the user. |
Scope
Enumeration for the scope of the attribute representing the resource in the API Hub to which the attribute can be linked.
Enums | |
---|---|
SCOPE_UNSPECIFIED |
Scope Unspecified. |
API |
Attribute can be linked to an API. |
VERSION |
Attribute can be linked to an API version. |
SPEC |
Attribute can be linked to a Spec. |
API_OPERATION |
Attribute can be linked to an API Operation. |
DEPLOYMENT |
Attribute can be linked to a Deployment. |
DEPENDENCY |
Attribute can be linked to a Dependency. |
DEFINITION |
Attribute can be linked to a definition. |
EXTERNAL_API |
Attribute can be linked to a ExternalAPI. |
PLUGIN |
Attribute can be linked to a Plugin. |
AttributeValues
The attribute values associated with resource.
Fields | |
---|---|
attribute |
Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
Union field Value . The attribute values associated with the resource. Value can be only one of the following: |
|
enum_values |
The attribute values associated with a resource in case attribute data type is enum. |
string_values |
The attribute values associated with a resource in case attribute data type is string. |
json_values |
The attribute values associated with a resource in case attribute data type is JSON. |
EnumAttributeValues
The attribute values of data type enum.
Fields | |
---|---|
values[] |
Required. The attribute values in case attribute data type is enum. |
StringAttributeValues
The attribute values of data type string or JSON.
Fields | |
---|---|
values[] |
Required. The attribute values in case attribute data type is string or JSON. |
CreateApiHubInstanceRequest
The CreateApiHubInstance
method's request.
Fields | |
---|---|
parent |
Required. The parent resource for the Api Hub instance resource. Format: |
api_hub_instance_id |
Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are |
api_hub_instance |
Required. The ApiHub instance. |
CreateApiRequest
The CreateApi
method's request.
Fields | |
---|---|
parent |
Required. The parent resource for the API resource. Format: |
api_id |
Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
api |
Required. The API resource to create. |
CreateAttributeRequest
The CreateAttribute
method's request.
Fields | |
---|---|
parent |
Required. The parent resource for Attribute. Format: |
attribute_id |
Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
attribute |
Required. The attribute to create. |
CreateDependencyRequest
The CreateDependency
method's request.
Fields | |
---|---|
parent |
Required. The parent resource for the dependency resource. Format: |
dependency_id |
Optional. The ID to use for the dependency resource, which will become the final component of the dependency's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if duplicate id is provided by the client. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are |
dependency |
Required. The dependency resource to create. |
CreateDeploymentRequest
The CreateDeployment
method's request.
Fields | |
---|---|
parent |
Required. The parent resource for the deployment resource. Format: |
deployment_id |
Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
deployment |
Required. The deployment resource to create. |
CreateExternalApiRequest
The CreateExternalApi
method's request.
Fields | |
---|---|
parent |
Required. The parent resource for the External API resource. Format: |
external_api_id |
Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
external_api |
Required. The External API resource to create. |
CreateHostProjectRegistrationRequest
The CreateHostProjectRegistration
method's request.
Fields | |
---|---|
parent |
Required. The parent resource for the host project. Format: |
host_project_registration_id |
Required. The ID to use for the Host Project Registration, which will become the final component of the host project registration's resource name. The ID must be the same as the Google cloud project specified in the host_project_registration.gcp_project field. |
host_project_registration |
Required. The host project registration to register. |
CreateRuntimeProjectAttachmentRequest
The CreateRuntimeProjectAttachment
method's request.
Fields | |
---|---|
parent |
Required. The parent resource for the Runtime Project Attachment. Format: |
runtime_project_attachment_id |
Required. The ID to use for the Runtime Project Attachment, which will become the final component of the Runtime Project Attachment's name. The ID must be the same as the project ID of the Google cloud project specified in the runtime_project_attachment.runtime_project field. |
runtime_project_attachment |
Required. The Runtime Project Attachment to create. |
CreateSpecRequest
The CreateSpec
method's request.
Fields | |
---|---|
parent |
Required. The parent resource for Spec. Format: |
spec_id |
Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
spec |
Required. The spec to create. |
CreateVersionRequest
The CreateVersion
method's request.
Fields | |
---|---|
parent |
Required. The parent resource for API version. Format: |
version_id |
Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
version |
Required. The version to create. |
Definition
Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only schema
object is supported.
Fields | |
---|---|
name |
Identifier. The name of the definition. Format: |
spec |
Output only. The name of the spec from where the definition was parsed. Format is |
type |
Output only. The type of the definition. |
create_time |
Output only. The time at which the definition was created. |
update_time |
Output only. The time at which the definition was last updated. |
attributes |
Optional. The list of user defined attributes associated with the definition resource. The key is the attribute name. It will be of the format: |
Union field
|
|
schema |
Output only. The value of a schema definition. |
Type
Enumeration of definition types.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Definition type unspecified. |
SCHEMA |
Definition type schema. |
DeleteApiRequest
The DeleteApi
method's request.
Fields | |
---|---|
name |
Required. The name of the API resource to delete. Format: |
force |
Optional. If set to true, any versions from this API will also be deleted. Otherwise, the request will only work if the API has no versions. |
DeleteAttributeRequest
The DeleteAttribute
method's request.
Fields | |
---|---|
name |
Required. The name of the attribute to delete. Format: |
DeleteDependencyRequest
The DeleteDependency
method's request.
Fields | |
---|---|
name |
Required. The name of the dependency resource to delete. Format: |
DeleteDeploymentRequest
The DeleteDeployment
method's request.
Fields | |
---|---|
name |
Required. The name of the deployment resource to delete. Format: |
DeleteExternalApiRequest
The DeleteExternalApi
method's request.
Fields | |
---|---|
name |
Required. The name of the External API resource to delete. Format: |
DeleteRuntimeProjectAttachmentRequest
The DeleteRuntimeProjectAttachment
method's request.
Fields | |
---|---|
name |
Required. The name of the Runtime Project Attachment to delete. Format: |
DeleteSpecRequest
The DeleteSpec
method's request.
Fields | |
---|---|
name |
Required. The name of the spec to delete. Format: |
DeleteVersionRequest
The DeleteVersion
method's request.
Fields | |
---|---|
name |
Required. The name of the version to delete. Format: |
force |
Optional. If set to true, any specs from this version will also be deleted. Otherwise, the request will only work if the version has no specs. |
Dependency
A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two [Operations][google.cloud.apihub.v1.Operation] or between an [Operation][google.cloud.apihub.v1.Operation] and External API
.
Fields | |
---|---|
name |
Identifier. The name of the dependency in the API Hub. Format: |
consumer |
Required. Immutable. The entity acting as the consumer in the dependency. |
supplier |
Required. Immutable. The entity acting as the supplier in the dependency. |
state |
Output only. State of the dependency. |
description |
Optional. Human readable description corresponding of the dependency. |
discovery_mode |
Output only. Discovery mode of the dependency. |
error_detail |
Output only. Error details of a dependency if the system has detected it internally. |
create_time |
Output only. The time at which the dependency was created. |
update_time |
Output only. The time at which the dependency was last updated. |
attributes |
Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: |
DiscoveryMode
Possible modes of discovering the dependency.
Enums | |
---|---|
DISCOVERY_MODE_UNSPECIFIED |
Default value. This value is unused. |
MANUAL |
Manual mode of discovery when the dependency is defined by the user. |
State
Possible states for a dependency.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
PROPOSED |
Dependency will be in a proposed state when it is newly identified by the API hub on its own. |
VALIDATED |
Dependency will be in a validated state when it is validated by the admin or manually created in the API hub. |
DependencyEntityReference
Reference to an entity participating in a dependency.
Fields | |
---|---|
display_name |
Output only. Display name of the entity. |
Union field identifier . Required. Unique identifier for the participating entity. identifier can be only one of the following: |
|
operation_resource_name |
The resource name of an operation in the API Hub. Format: |
external_api_resource_name |
The resource name of an external API in the API Hub. Format: |
DependencyErrorDetail
Details describing error condition of a dependency.
Fields | |
---|---|
error |
Optional. Error in the dependency. |
error_time |
Optional. Timestamp at which the error was found. |
Error
Possible values representing an error in the dependency.
Enums | |
---|---|
ERROR_UNSPECIFIED |
Default value used for no error in the dependency. |
SUPPLIER_NOT_FOUND |
Supplier entity has been deleted. |
SUPPLIER_RECREATED |
Supplier entity has been recreated. |
Deployment
Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.
Fields | |
---|---|
name |
Identifier. The name of the deployment. Format: |
display_name |
Required. The display name of the deployment. |
description |
Optional. The description of the deployment. |
documentation |
Optional. The documentation of the deployment. |
deployment_type |
Required. The type of deployment. This maps to the following system defined attribute: |
resource_uri |
Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy. |
endpoints[] |
Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses. |
api_versions[] |
Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). |
create_time |
Output only. The time at which the deployment was created. |
update_time |
Output only. The time at which the deployment was last updated. |
slo |
Optional. The SLO for this deployment. This maps to the following system defined attribute: |
environment |
Optional. The environment mapping to this deployment. This maps to the following system defined attribute: |
attributes |
Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: |
DisablePluginRequest
The DisablePlugin
method's request.
Fields | |
---|---|
name |
Required. The name of the plugin to disable. Format: |
Documentation
Documentation details.
Fields | |
---|---|
external_uri |
Optional. The uri of the externally hosted documentation. |
EnablePluginRequest
The EnablePlugin
method's request.
Fields | |
---|---|
name |
Required. The name of the plugin to enable. Format: |
ExternalApi
An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
Fields | |
---|---|
name |
Identifier. Format: |
display_name |
Required. Display name of the external API. Max length is 63 characters (Unicode Code Points). |
description |
Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points). |
endpoints[] |
Optional. List of endpoints on which this API is accessible. |
paths[] |
Optional. List of paths served by this API. |
documentation |
Optional. Documentation of the external API. |
attributes |
Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: |
create_time |
Output only. Creation timestamp. |
update_time |
Output only. Last update timestamp. |
GetApiHubInstanceRequest
The GetApiHubInstance
method's request.
Fields | |
---|---|
name |
Required. The name of the Api Hub instance to retrieve. Format: |
GetApiOperationRequest
The GetApiOperation
method's request.
Fields | |
---|---|
name |
Required. The name of the operation to retrieve. Format: |
GetApiRequest
The GetApi
method's request.
Fields | |
---|---|
name |
Required. The name of the API resource to retrieve. Format: |
GetAttributeRequest
The GetAttribute
method's request.
Fields | |
---|---|
name |
Required. The name of the attribute to retrieve. Format: |
GetDefinitionRequest
The GetDefinition
method's request.
Fields | |
---|---|
name |
Required. The name of the definition to retrieve. Format: |
GetDependencyRequest
The [GetDependency][.ApiHubDependencies.GetDependency] method's request.
Fields | |
---|---|
name |
Required. The name of the dependency resource to retrieve. Format: |
GetDeploymentRequest
The GetDeployment
method's request.
Fields | |
---|---|
name |
Required. The name of the deployment resource to retrieve. Format: |
GetExternalApiRequest
The GetExternalApi
method's request.
Fields | |
---|---|
name |
Required. The name of the External API resource to retrieve. Format: |
GetHostProjectRegistrationRequest
The GetHostProjectRegistration
method's request.
Fields | |
---|---|
name |
Required. Host project registration resource name. projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration_id} |
GetPluginRequest
The GetPlugin
method's request.
Fields | |
---|---|
name |
Required. The name of the plugin to retrieve. Format: |
GetRuntimeProjectAttachmentRequest
The GetRuntimeProjectAttachment
method's request.
Fields | |
---|---|
name |
Required. The name of the API resource to retrieve. Format: |
GetSpecContentsRequest
The GetSpecContents
method's request.
Fields | |
---|---|
name |
Required. The name of the spec whose contents need to be retrieved. Format: |
GetSpecRequest
The GetSpec
method's request.
Fields | |
---|---|
name |
Required. The name of the spec to retrieve. Format: |
GetStyleGuideContentsRequest
The [GetStyleGuideContents][ApiHub.GetStyleGuideContents] method's request.
Fields | |
---|---|
name |
Required. The name of the StyleGuide whose contents need to be retrieved. There is exactly one style guide resource per project per location. The expected format is |
GetStyleGuideRequest
The [GetStyleGuide][ApiHub.GetStyleGuide] method's request.
Fields | |
---|---|
name |
Required. The name of the spec to retrieve. Format: |
GetVersionRequest
The GetVersion
method's request.
Fields | |
---|---|
name |
Required. The name of the API version to retrieve. Format: |
HostProjectRegistration
Host project registration refers to the registration of a Google cloud project with Api Hub as a host project. This is the project where Api Hub is provisioned. It acts as the consumer project for the Api Hub instance provisioned. Multiple runtime projects can be attached to the host project and these attachments define the scope of Api Hub.
Fields | |
---|---|
name |
Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}". |
gcp_project |
Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number. |
create_time |
Output only. The time at which the host project registration was created. |
HttpOperation
The HTTP Operation.
Fields | |
---|---|
path |
Output only. The path details for the Operation. |
method |
Output only. Operation method |
Method
Enumeration of Method types.
Enums | |
---|---|
METHOD_UNSPECIFIED |
Method unspecified. |
GET |
Get Operation type. |
PUT |
Put Operation type. |
POST |
Post Operation type. |
DELETE |
Delete Operation type. |
OPTIONS |
Options Operation type. |
HEAD |
Head Operation type. |
PATCH |
Patch Operation type. |
TRACE |
Trace Operation type. |
Issue
Issue contains the details of a single issue found by the linter.
Fields | |
---|---|
code |
Required. Rule code unique to each rule defined in linter. |
path[] |
Required. An array of strings indicating the location in the analyzed document where the rule was triggered. |
message |
Required. Human-readable message describing the issue found by the linter. |
severity |
Required. Severity level of the rule violation. |
range |
Required. Object describing where in the file the issue was found. |
LintResponse
LintResponse contains the response from the linter.
Fields | |
---|---|
issues[] |
Optional. Array of issues found in the analyzed document. |
summary[] |
Optional. Summary of all issue types and counts for each severity level. |
state |
Required. Lint state represents success or failure for linting. |
source |
Required. Name of the linting application. |
linter |
Required. Name of the linter used. |
create_time |
Required. Timestamp when the linting response was generated. |
SummaryEntry
Count of issues with a given severity.
Fields | |
---|---|
severity |
Required. Severity of the issue. |
count |
Required. Count of issues with the given severity. |
LintSpecRequest
The [LintSpec][ApiHub.LintSpec] method's request.
Fields | |
---|---|
name |
Required. The name of the spec to be linted. Format: |
LintState
Lint state represents success or failure for linting.
Enums | |
---|---|
LINT_STATE_UNSPECIFIED |
Lint state unspecified. |
LINT_STATE_SUCCESS |
Linting was completed successfully. |
LINT_STATE_ERROR |
Linting encountered errors. |
Linter
Enumeration of linter types.
Enums | |
---|---|
LINTER_UNSPECIFIED |
Linter type unspecified. |
SPECTRAL |
Linter type spectral. |
OTHER |
Linter type other. |
ListApiOperationsRequest
The ListApiOperations
method's request.
Fields | |
---|---|
parent |
Required. The parent which owns this collection of operations i.e., the API version. Format: |
filter |
Optional. An expression that filters the list of ApiOperations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: The following fields in the Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListApiOperationsResponse
The ListApiOperations
method's response.
Fields | |
---|---|
api_operations[] |
The operations corresponding to an API version. |
next_page_token |
A token, which can be sent as |
ListApisRequest
The ListApis
method's request.
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of API resources. Format: |
filter |
Optional. An expression that filters the list of ApiResources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: The following fields in the
Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of API resources to return. The service may return fewer than this value. If unspecified, at most 50 Apis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListApisResponse
The ListApis
method's response.
Fields | |
---|---|
apis[] |
The API resources present in the API hub. |
next_page_token |
A token, which can be sent as |
ListAttributesRequest
The ListAttributes
method's request.
Fields | |
---|---|
parent |
Required. The parent resource for Attribute. Format: |
filter |
Optional. An expression that filters the list of Attributes. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: The following fields in the
Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of attribute resources to return. The service may return fewer than this value. If unspecified, at most 50 attributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListAttributesResponse
The ListAttributes
method's response.
Fields | |
---|---|
attributes[] |
The list of all attributes. |
next_page_token |
A token, which can be sent as |
ListDependenciesRequest
The ListDependencies
method's request.
Fields | |
---|---|
parent |
Required. The parent which owns this collection of dependency resources. Format: |
filter |
Optional. An expression that filters the list of Dependencies. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. Allowed comparison operator is The following fields in the
Expressions are combined with either For example, |
page_size |
Optional. The maximum number of dependency resources to return. The service may return fewer than this value. If unspecified, at most 50 dependencies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListDependenciesResponse
The ListDependencies
method's response.
Fields | |
---|---|
dependencies[] |
The dependency resources present in the API hub. |
next_page_token |
A token, which can be sent as |
ListDeploymentsRequest
The ListDeployments
method's request.
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of deployment resources. Format: |
filter |
Optional. An expression that filters the list of Deployments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: The following fields in the
Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of deployment resources to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListDeploymentsResponse
The ListDeployments
method's response.
Fields | |
---|---|
deployments[] |
The deployment resources present in the API hub. |
next_page_token |
A token, which can be sent as |
ListExternalApisRequest
The ListExternalApis
method's request.
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of External API resources. Format: |
page_size |
Optional. The maximum number of External API resources to return. The service may return fewer than this value. If unspecified, at most 50 ExternalApis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListExternalApisResponse
The ListExternalApis
method's response.
Fields | |
---|---|
external_apis[] |
The External API resources present in the API hub. |
next_page_token |
A token, which can be sent as |
ListHostProjectRegistrationsRequest
The ListHostProjectRegistrations
method's request.
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of host projects. Format: |
page_size |
Optional. The maximum number of host project registrations to return. The service may return fewer than this value. If unspecified, at most 50 host project registrations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
filter |
Optional. An expression that filters the list of HostProjectRegistrations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the
|
order_by |
Optional. Hint for how to order the results. |
ListHostProjectRegistrationsResponse
The ListHostProjectRegistrations
method's response.
Fields | |
---|---|
host_project_registrations[] |
The list of host project registrations. |
next_page_token |
A token, which can be sent as |
ListRuntimeProjectAttachmentsRequest
The ListRuntimeProjectAttachments
method's request.
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of runtime project attachments. Format: |
page_size |
Optional. The maximum number of runtime project attachments to return. The service may return fewer than this value. If unspecified, at most 50 runtime project attachments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
filter |
Optional. An expression that filters the list of RuntimeProjectAttachments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the
|
order_by |
Optional. Hint for how to order the results. |
ListRuntimeProjectAttachmentsResponse
The ListRuntimeProjectAttachments
method's response.
Fields | |
---|---|
runtime_project_attachments[] |
List of runtime project attachments. |
next_page_token |
A token, which can be sent as |
ListSpecsRequest
The [ListSpecs][ListSpecs] method's request.
Fields | |
---|---|
parent |
Required. The parent, which owns this collection of specs. Format: |
filter |
Optional. An expression that filters the list of Specs. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: The following fields in the
Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 specs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListSpecsResponse
The ListSpecs
method's response.
Fields | |
---|---|
specs[] |
The specs corresponding to an API Version. |
next_page_token |
A token, which can be sent as |
ListVersionsRequest
The ListVersions
method's request.
Fields | |
---|---|
parent |
Required. The parent which owns this collection of API versions i.e., the API resource Format: |
filter |
Optional. An expression that filters the list of Versions. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: The following fields in the
Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListVersionsResponse
The ListVersions
method's response.
Fields | |
---|---|
versions[] |
The versions corresponding to an API. |
next_page_token |
A token, which can be sent as |
LookupApiHubInstanceRequest
The LookupApiHubInstance
method's request.
Fields | |
---|---|
parent |
Required. There will always be only one Api Hub instance for a Google Cloud project across all locations. The parent resource for the Api Hub instance resource. Format: |
LookupApiHubInstanceResponse
The LookupApiHubInstance
method's response.`
Fields | |
---|---|
api_hub_instance |
API Hub instance for a project if it exists, empty otherwise. |
LookupRuntimeProjectAttachmentRequest
The LookupRuntimeProjectAttachment
method's request.
Fields | |
---|---|
name |
Required. Runtime project ID to look up runtime project attachment for. Lookup happens across all regions. Expected format: |
LookupRuntimeProjectAttachmentResponse
The ListRuntimeProjectAttachments
method's response.
Fields | |
---|---|
runtime_project_attachment |
Runtime project attachment for a project if exists, empty otherwise. |
OpenApiSpecDetails
OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails
.
Fields | |
---|---|
format |
Output only. The format of the spec. |
version |
Output only. The version in the spec. This maps to |
owner |
Output only. Owner details for the spec. This maps to |
Format
Enumeration of spec formats.
Enums | |
---|---|
FORMAT_UNSPECIFIED |
SpecFile type unspecified. |
OPEN_API_SPEC_2_0 |
OpenAPI Spec v2.0. |
OPEN_API_SPEC_3_0 |
OpenAPI Spec v3.0. |
OPEN_API_SPEC_3_1 |
OpenAPI Spec v3.1. |
OperationDetails
The operation details parsed from the spec.
Fields | |
---|---|
description |
Output only. Description of the operation behavior. For OpenAPI spec, this will map to |
documentation |
Output only. Additional external documentation for this operation. For OpenAPI spec, this will map to |
deprecated |
Output only. For OpenAPI spec, this will be set if |
Union field
|
|
http_operation |
The HTTP Operation. |
OperationMetadata
Represents the metadata of the long-running operation.
Fields | |
---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
target |
Output only. Server-defined resource path for the target of the operation. |
verb |
Output only. Name of the verb executed by the operation. |
status_message |
Output only. Human-readable status of the operation, if any. |
requested_cancellation |
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a |
api_version |
Output only. API version used to start the operation. |
Owner
Owner details.
Fields | |
---|---|
display_name |
Optional. The name of the owner. |
email |
Required. The email of the owner. |
Path
The path details derived from the spec.
Fields | |
---|---|
path |
Output only. Complete path relative to server endpoint. |
description |
Output only. A short description for the path applicable to all operations. |
Plugin
A plugin resource in the API Hub.
Fields | |
---|---|
name |
Identifier. The name of the plugin. Format: |
display_name |
Required. The display name of the plugin. Max length is 50 characters (Unicode code points). |
type |
Required. The type of the API. This maps to the following system defined attribute: |
description |
Optional. The plugin description. Max length is 2000 characters (Unicode code points). |
state |
Output only. Represents the state of the plugin. |
State
Possible states a plugin can have. Note that this enum may receive new values in the future. Consumers are advised to always code against the enum values expecting new states can be added later on.
Enums | |
---|---|
STATE_UNSPECIFIED |
The default value. This value is used if the state is omitted. |
ENABLED |
The plugin is enabled. |
DISABLED |
The plugin is disabled. |
Point
Point within the file (line and character).
Fields | |
---|---|
line |
Required. Line number (zero-indexed). |
character |
Required. Character position within the line (zero-indexed). |
Range
Object describing where in the file the issue was found.
Fields | |
---|---|
start |
Required. Start of the issue. |
end |
Required. End of the issue. |
RuntimeProjectAttachment
Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.
Fields | |
---|---|
name |
Identifier. The resource name of a runtime project attachment. Format: "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}". |
runtime_project |
Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number. |
create_time |
Output only. Create time. |
Schema
The schema details derived from the spec. Currently, this entity is supported for OpenAPI spec only. For OpenAPI spec, this maps to the schema defined in the definitions
section for OpenAPI 2.0 version and in components.schemas
section for OpenAPI 3.0 and 3.1 version.
Fields | |
---|---|
display_name |
Output only. The display name of the schema. This will map to the name of the schema in the spec. |
raw_value |
Output only. The raw value of the schema definition corresponding to the schema name in the spec. |
SearchResourcesRequest
The SearchResources
method's request.
Fields | |
---|---|
location |
Required. The resource name of the location which will be of the type |
query |
Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc. |
filter |
Optional. An expression that filters the list of search results. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be The following field names are eligible for filtering: * Here are is an example:
|
page_size |
Optional. The maximum number of search results to return. The service may return fewer than this value. If unspecified at most 10 search results will be returned. If value is negative then |
page_token |
Optional. A page token, received from a previous [SearchResources][SearchResources] call. Specify this parameter to retrieve the next page of transactions. When paginating, you must specify the |
SearchResourcesResponse
Response for the SearchResources
method.
Fields | |
---|---|
search_results[] |
List of search results according to the filter and search query specified. The order of search results represents the ranking. |
next_page_token |
Pass this token in the |
SearchResult
Represents the search results.
Fields | |
---|---|
resource |
This represents the ApiHubResource. Note: Only selected fields of the resources are populated in response. |
Severity
Severity of the issue.
Enums | |
---|---|
SEVERITY_UNSPECIFIED |
Severity unspecified. |
SEVERITY_ERROR |
Severity error. |
SEVERITY_WARNING |
Severity warning. |
SEVERITY_INFO |
Severity info. |
SEVERITY_HINT |
Severity hint. |
Spec
Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
Fields | |
---|---|
name |
Identifier. The name of the spec. Format: |
display_name |
Required. The display name of the spec. This can contain the file name of the spec. |
spec_type |
Required. The type of spec. The value should be one of the allowed values defined for Note, this field is mandatory if content is provided. |
contents |
Optional. Input only. The contents of the uploaded spec. |
details |
Output only. Details parsed from the spec. |
source_uri |
Optional. The URI of the spec source in case file is uploaded from an external version control system. |
create_time |
Output only. The time at which the spec was created. |
update_time |
Output only. The time at which the spec was last updated. |
lint_response |
Optional. The lint response for the spec. |
attributes |
Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: |
documentation |
Optional. The documentation of the spec. For OpenAPI spec, this will be populated from |
parsing_mode |
Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing. |
ParsingMode
Specifies the parsing mode for API specifications during creation and update. - RELAXED
: Parsing errors in the specification content do not fail the API call. - STRICT
: Parsing errors in the specification content result in failure of the API call. If not specified, defaults to RELAXED
.
Enums | |
---|---|
PARSING_MODE_UNSPECIFIED |
Defaults to RELAXED . |
RELAXED |
Parsing of the Spec on create and update is relaxed, meaning that parsing errors the spec contents will not fail the API call. |
STRICT |
Parsing of the Spec on create and update is strict, meaning that parsing errors in the spec contents will fail the API call. |
SpecContents
The spec contents.
Fields | |
---|---|
contents |
Required. The contents of the spec. |
mime_type |
Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. |
SpecDetails
SpecDetails contains the details parsed from supported spec types.
Fields | |
---|---|
description |
Output only. The description of the spec. |
Union field
|
|
open_api_spec_details |
Output only. Additional details apart from |
StyleGuide
Represents a singleton style guide resource to be used for linting Open API specs.
Fields | |
---|---|
name |
Identifier. The name of the style guide. Format: |
linter |
Required. Target linter for the style guide. |
contents |
Required. Input only. The contents of the uploaded style guide. |
StyleGuideContents
The style guide contents.
Fields | |
---|---|
contents |
Required. The contents of the style guide. |
mime_type |
Required. The mime type of the content. |
UpdateApiRequest
The UpdateApi
method's request.
Fields | |
---|---|
api |
Required. The API resource to update. The API resource's |
update_mask |
Required. The list of fields to update. |
UpdateAttributeRequest
The UpdateAttribute
method's request.
Fields | |
---|---|
attribute |
Required. The attribute to update. The attribute's |
update_mask |
Required. The list of fields to update. |
UpdateDependencyRequest
The UpdateDependency
method's request.
Fields | |
---|---|
dependency |
Required. The dependency resource to update. The dependency's |
update_mask |
Required. The list of fields to update. |
UpdateDeploymentRequest
The UpdateDeployment
method's request.
Fields | |
---|---|
deployment |
Required. The deployment resource to update. The deployment resource's |
update_mask |
Required. The list of fields to update. |
UpdateExternalApiRequest
The UpdateExternalApi
method's request.
Fields | |
---|---|
external_api |
Required. The External API resource to update. The External API resource's |
update_mask |
|