GoogleCloudApihubV1Spec

import type { GoogleCloudApihubV1Spec } from "https://googleapis.deno.dev/v1/apihub:v1.ts";

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.

interface GoogleCloudApihubV1Spec {

attributes?: {

[key: string]: GoogleCloudApihubV1AttributeValues;

};

contents?: GoogleCloudApihubV1SpecContents;

readonly createTime?: Date;

readonly details?: GoogleCloudApihubV1SpecDetails;

displayName?: string;

documentation?: GoogleCloudApihubV1Documentation;

lintResponse?: GoogleCloudApihubV1LintResponse;

name?: string;

parsingMode?: "PARSING_MODE_UNSPECIFIED" | "RELAXED" | "STRICT";

readonly sourceMetadata?: GoogleCloudApihubV1SourceMetadata[];

sourceUri?: string;

specType?: GoogleCloudApihubV1AttributeValues;

readonly updateTime?: Date;

}

§Properties

attributes?: {

[key: string]: GoogleCloudApihubV1AttributeValues;

}

[src]

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.

contents?: GoogleCloudApihubV1SpecContents

[src]

Optional. Input only. The contents of the uploaded spec.

readonly createTime?: Date

[src]

Output only. The time at which the spec was created.

readonly details?: GoogleCloudApihubV1SpecDetails

[src]

Output only. Details parsed from the spec.

displayName?: string

[src]

Required. The display name of the spec. This can contain the file name of the spec.

documentation?: GoogleCloudApihubV1Documentation

[src]

Optional. The documentation of the spec. For OpenAPI spec, this will be populated from externalDocs in OpenAPI spec.

lintResponse?: GoogleCloudApihubV1LintResponse

[src]

Optional. The lint response for the spec.

name?: string

[src]

Identifier. The name of the spec. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

parsingMode?: "PARSING_MODE_UNSPECIFIED" | "RELAXED" | "STRICT"

[src]

Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.

readonly sourceMetadata?: GoogleCloudApihubV1SourceMetadata[]

[src]

Output only. The list of sources and metadata from the sources of the spec.

sourceUri?: string

[src]

Optional. The URI of the spec source in case file is uploaded from an external version control system.

specType?: GoogleCloudApihubV1AttributeValues

[src]

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.

readonly updateTime?: Date

[src]

Output only. The time at which the spec was last updated.