| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="apihub_v1.html">API hub API</a> . <a href="apihub_v1.projects.html">projects</a> . <a href="apihub_v1.projects.locations.html">locations</a> . <a href="apihub_v1.projects.locations.apis.html">apis</a> . <a href="apihub_v1.projects.locations.apis.versions.html">versions</a> . <a href="apihub_v1.projects.locations.apis.versions.specs.html">specs</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, specId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">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 `contents` or `source_uri` must be provided. If `contents` is provided, then `spec_type` must also be provided. 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 `projects/{project}/locations/{location}/attributes/system-spec-type` attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the GetSpec method. In order to access the raw contents for a particular spec, use the GetSpecContents method. In order to access the operations parsed from the spec, use the ListAPIOperations method.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete a spec. Deleting a spec will also delete the associated operations from the version.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use GetSpecContents method to retrieve the same.</p> |
| <p class="toc_element"> |
| <code><a href="#getContents">getContents(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get spec contents.</p> |
| <p class="toc_element"> |
| <code><a href="#lint">lint(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">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.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List specs corresponding to a particular API resource.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update spec. The following fields in the spec can be updated: * display_name * source_uri * lint_response * attributes * contents * spec_type 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 update_mask should be used to specify the fields being updated.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, specId=None, x__xgafv=None)</code> |
| <pre>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 `contents` or `source_uri` must be provided. If `contents` is provided, then `spec_type` must also be provided. 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 `projects/{project}/locations/{location}/attributes/system-spec-type` attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the GetSpec method. In order to access the raw contents for a particular spec, use the GetSpecContents method. In order to access the operations parsed from the spec, use the ListAPIOperations method. |
| |
| Args: |
| parent: string, Required. The parent resource for Spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # 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. |
| "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec. |
| "contents": "A String", # Required. The contents of the spec. |
| "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. |
| }, |
| "createTime": "A String", # Output only. The time at which the spec was created. |
| "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. |
| "description": "A String", # Output only. The description of the spec. |
| "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. |
| "format": "A String", # Output only. The format of the spec. |
| "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec. |
| }, |
| }, |
| "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec. |
| "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec. |
| "createTime": "A String", # Required. Timestamp when the linting response was generated. |
| "issues": [ # Optional. Array of issues found in the analyzed document. |
| { # Issue contains the details of a single issue found by the linter. |
| "code": "A String", # Required. Rule code unique to each rule defined in linter. |
| "message": "A String", # Required. Human-readable message describing the issue found by the linter. |
| "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered. |
| "A String", |
| ], |
| "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found. |
| "end": { # Point within the file (line and character). # Required. End of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| "start": { # Point within the file (line and character). # Required. Start of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| }, |
| "severity": "A String", # Required. Severity level of the rule violation. |
| }, |
| ], |
| "linter": "A String", # Required. Name of the linter used. |
| "source": "A String", # Required. Name of the linting application. |
| "state": "A String", # Required. Lint state represents success or failure for linting. |
| "summary": [ # Optional. Summary of all issue types and counts for each severity level. |
| { # Count of issues with a given severity. |
| "count": 42, # Required. Count of issues with the given severity. |
| "severity": "A String", # Required. Severity of the issue. |
| }, |
| ], |
| }, |
| "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` |
| "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing. |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system. |
| "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the spec was last updated. |
| } |
| |
| specId: string, Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another spec in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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. |
| "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec. |
| "contents": "A String", # Required. The contents of the spec. |
| "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. |
| }, |
| "createTime": "A String", # Output only. The time at which the spec was created. |
| "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. |
| "description": "A String", # Output only. The description of the spec. |
| "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. |
| "format": "A String", # Output only. The format of the spec. |
| "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec. |
| }, |
| }, |
| "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec. |
| "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec. |
| "createTime": "A String", # Required. Timestamp when the linting response was generated. |
| "issues": [ # Optional. Array of issues found in the analyzed document. |
| { # Issue contains the details of a single issue found by the linter. |
| "code": "A String", # Required. Rule code unique to each rule defined in linter. |
| "message": "A String", # Required. Human-readable message describing the issue found by the linter. |
| "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered. |
| "A String", |
| ], |
| "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found. |
| "end": { # Point within the file (line and character). # Required. End of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| "start": { # Point within the file (line and character). # Required. Start of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| }, |
| "severity": "A String", # Required. Severity level of the rule violation. |
| }, |
| ], |
| "linter": "A String", # Required. Name of the linter used. |
| "source": "A String", # Required. Name of the linting application. |
| "state": "A String", # Required. Lint state represents success or failure for linting. |
| "summary": [ # Optional. Summary of all issue types and counts for each severity level. |
| { # Count of issues with a given severity. |
| "count": 42, # Required. Count of issues with the given severity. |
| "severity": "A String", # Required. Severity of the issue. |
| }, |
| ], |
| }, |
| "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` |
| "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing. |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system. |
| "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the spec was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Delete a spec. Deleting a spec will also delete the associated operations from the version. |
| |
| Args: |
| name: string, Required. The name of the spec to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use GetSpecContents method to retrieve the same. |
| |
| Args: |
| name: string, Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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. |
| "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec. |
| "contents": "A String", # Required. The contents of the spec. |
| "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. |
| }, |
| "createTime": "A String", # Output only. The time at which the spec was created. |
| "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. |
| "description": "A String", # Output only. The description of the spec. |
| "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. |
| "format": "A String", # Output only. The format of the spec. |
| "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec. |
| }, |
| }, |
| "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec. |
| "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec. |
| "createTime": "A String", # Required. Timestamp when the linting response was generated. |
| "issues": [ # Optional. Array of issues found in the analyzed document. |
| { # Issue contains the details of a single issue found by the linter. |
| "code": "A String", # Required. Rule code unique to each rule defined in linter. |
| "message": "A String", # Required. Human-readable message describing the issue found by the linter. |
| "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered. |
| "A String", |
| ], |
| "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found. |
| "end": { # Point within the file (line and character). # Required. End of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| "start": { # Point within the file (line and character). # Required. Start of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| }, |
| "severity": "A String", # Required. Severity level of the rule violation. |
| }, |
| ], |
| "linter": "A String", # Required. Name of the linter used. |
| "source": "A String", # Required. Name of the linting application. |
| "state": "A String", # Required. Lint state represents success or failure for linting. |
| "summary": [ # Optional. Summary of all issue types and counts for each severity level. |
| { # Count of issues with a given severity. |
| "count": 42, # Required. Count of issues with the given severity. |
| "severity": "A String", # Required. Severity of the issue. |
| }, |
| ], |
| }, |
| "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` |
| "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing. |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system. |
| "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the spec was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getContents">getContents(name, x__xgafv=None)</code> |
| <pre>Get spec contents. |
| |
| Args: |
| name: string, Required. The name of the spec whose contents need to be retrieved. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The spec contents. |
| "contents": "A String", # Required. The contents of the spec. |
| "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="lint">lint(name, body=None, x__xgafv=None)</code> |
| <pre>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. |
| |
| Args: |
| name: string, Required. The name of the spec to be linted. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The LintSpec method's request. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>List specs corresponding to a particular API resource. |
| |
| Args: |
| parent: string, Required. The parent, which owns this collection of specs. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` (required) |
| filter: string, 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: `<`, `>`, `:` or `=`. Filters are not case sensitive. The following fields in the `Spec` are eligible for filtering: * `display_name` - The display name of the Spec. Allowed comparison operators: `=`. * `create_time` - The time at which the Spec was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `spec_type.enum_values.values.id` - The allowed value id of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `spec_type.enum_values.values.display_name` - The allowed value display name of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `lint_response.json_values.values` - The json value of the lint_response attribute associated with the Spec. Allowed comparison operators: `:`. * `mime_type` - The MIME type of the Spec. Allowed comparison operators: `=`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `spec_type.enum_values.values.id: rest-id` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_. * `spec_type.enum_values.values.display_name: \"Rest Display Name\"` - The filter string specifies that the display name of the allowed value associated with the spec_type attribute is `Rest Display Name`. * `spec_type.enum_values.values.id: grpc-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The id of the allowed value associated with the spec_type attribute is _grpc-id_ and the spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `spec_type.enum_values.values.id: rest-id OR spec_type.enum_values.values.id: grpc-id` - The id of the allowed value associated with the spec_type attribute is _rest-id_ or _grpc-id_. * `spec_type.enum_values.values.id: rest-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_ and the id of the allowed value associated with the user defined attribute of type enum is _test_. |
| pageSize: integer, 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. |
| pageToken: string, Optional. A page token, received from a previous `ListSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSpecs` must match the call that provided the page token. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The ListSpecs method's response. |
| "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| "specs": [ # The specs corresponding to an API Version. |
| { # 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. |
| "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec. |
| "contents": "A String", # Required. The contents of the spec. |
| "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. |
| }, |
| "createTime": "A String", # Output only. The time at which the spec was created. |
| "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. |
| "description": "A String", # Output only. The description of the spec. |
| "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. |
| "format": "A String", # Output only. The format of the spec. |
| "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec. |
| }, |
| }, |
| "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec. |
| "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec. |
| "createTime": "A String", # Required. Timestamp when the linting response was generated. |
| "issues": [ # Optional. Array of issues found in the analyzed document. |
| { # Issue contains the details of a single issue found by the linter. |
| "code": "A String", # Required. Rule code unique to each rule defined in linter. |
| "message": "A String", # Required. Human-readable message describing the issue found by the linter. |
| "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered. |
| "A String", |
| ], |
| "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found. |
| "end": { # Point within the file (line and character). # Required. End of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| "start": { # Point within the file (line and character). # Required. Start of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| }, |
| "severity": "A String", # Required. Severity level of the rule violation. |
| }, |
| ], |
| "linter": "A String", # Required. Name of the linter used. |
| "source": "A String", # Required. Name of the linting application. |
| "state": "A String", # Required. Lint state represents success or failure for linting. |
| "summary": [ # Optional. Summary of all issue types and counts for each severity level. |
| { # Count of issues with a given severity. |
| "count": 42, # Required. Count of issues with the given severity. |
| "severity": "A String", # Required. Severity of the issue. |
| }, |
| ], |
| }, |
| "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` |
| "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing. |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system. |
| "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the spec was last updated. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Update spec. The following fields in the spec can be updated: * display_name * source_uri * lint_response * attributes * contents * spec_type 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 update_mask should be used to specify the fields being updated. |
| |
| Args: |
| name: string, Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # 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. |
| "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec. |
| "contents": "A String", # Required. The contents of the spec. |
| "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. |
| }, |
| "createTime": "A String", # Output only. The time at which the spec was created. |
| "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. |
| "description": "A String", # Output only. The description of the spec. |
| "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. |
| "format": "A String", # Output only. The format of the spec. |
| "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec. |
| }, |
| }, |
| "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec. |
| "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec. |
| "createTime": "A String", # Required. Timestamp when the linting response was generated. |
| "issues": [ # Optional. Array of issues found in the analyzed document. |
| { # Issue contains the details of a single issue found by the linter. |
| "code": "A String", # Required. Rule code unique to each rule defined in linter. |
| "message": "A String", # Required. Human-readable message describing the issue found by the linter. |
| "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered. |
| "A String", |
| ], |
| "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found. |
| "end": { # Point within the file (line and character). # Required. End of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| "start": { # Point within the file (line and character). # Required. Start of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| }, |
| "severity": "A String", # Required. Severity level of the rule violation. |
| }, |
| ], |
| "linter": "A String", # Required. Name of the linter used. |
| "source": "A String", # Required. Name of the linting application. |
| "state": "A String", # Required. Lint state represents success or failure for linting. |
| "summary": [ # Optional. Summary of all issue types and counts for each severity level. |
| { # Count of issues with a given severity. |
| "count": 42, # Required. Count of issues with the given severity. |
| "severity": "A String", # Required. Severity of the issue. |
| }, |
| ], |
| }, |
| "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` |
| "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing. |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system. |
| "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the spec was last updated. |
| } |
| |
| updateMask: string, Required. The list of fields to update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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. |
| "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec. |
| "contents": "A String", # Required. The contents of the spec. |
| "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. |
| }, |
| "createTime": "A String", # Output only. The time at which the spec was created. |
| "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. |
| "description": "A String", # Output only. The description of the spec. |
| "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. |
| "format": "A String", # Output only. The format of the spec. |
| "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec. |
| }, |
| }, |
| "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec. |
| "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec. |
| "createTime": "A String", # Required. Timestamp when the linting response was generated. |
| "issues": [ # Optional. Array of issues found in the analyzed document. |
| { # Issue contains the details of a single issue found by the linter. |
| "code": "A String", # Required. Rule code unique to each rule defined in linter. |
| "message": "A String", # Required. Human-readable message describing the issue found by the linter. |
| "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered. |
| "A String", |
| ], |
| "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found. |
| "end": { # Point within the file (line and character). # Required. End of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| "start": { # Point within the file (line and character). # Required. Start of the issue. |
| "character": 42, # Required. Character position within the line (zero-indexed). |
| "line": 42, # Required. Line number (zero-indexed). |
| }, |
| }, |
| "severity": "A String", # Required. Severity level of the rule violation. |
| }, |
| ], |
| "linter": "A String", # Required. Name of the linter used. |
| "source": "A String", # Required. Name of the linting application. |
| "state": "A String", # Required. Lint state represents success or failure for linting. |
| "summary": [ # Optional. Summary of all issue types and counts for each severity level. |
| { # Count of issues with a given severity. |
| "count": 42, # Required. Count of issues with the given severity. |
| "severity": "A String", # Required. Severity of the issue. |
| }, |
| ], |
| }, |
| "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` |
| "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing. |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system. |
| "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # 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-/. |
| "immutable": True or False, # 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. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the spec was last updated. |
| }</pre> |
| </div> |
| |
| </body></html> |
