API

API

pyatlan.model.assets.a_p_i.API(__pydantic_self__, **data: Any)

Bases: Catalog

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

API_EXTERNAL_DOCS: KeywordField = KeywordField('apiExternalDocs', 'apiExternalDocs') class-attribute

External documentation of the API.

API_IS_AUTH_OPTIONAL: BooleanField = BooleanField('apiIsAuthOptional', 'apiIsAuthOptional') class-attribute

Whether authentication is optional (true) or required (false).

API_IS_OBJECT_REFERENCE: BooleanField = BooleanField('apiIsObjectReference', 'apiIsObjectReference') class-attribute

If this asset refers to an APIObject

API_OBJECT_QUALIFIED_NAME: KeywordField = KeywordField('apiObjectQualifiedName', 'apiObjectQualifiedName') class-attribute

Qualified name of the APIObject that is referred to by this asset. When apiIsObjectReference is true.

API_SPEC_NAME: KeywordTextField = KeywordTextField('apiSpecName', 'apiSpecName.keyword', 'apiSpecName') class-attribute

Simple name of the API spec, if this asset is contained in an API spec.

API_SPEC_QUALIFIED_NAME: KeywordTextField = KeywordTextField('apiSpecQualifiedName', 'apiSpecQualifiedName', 'apiSpecQualifiedName.text') class-attribute

Unique name of the API spec, if this asset is contained in an API spec.

API_SPEC_TYPE: KeywordField = KeywordField('apiSpecType', 'apiSpecType') class-attribute

Type of API, for example: OpenAPI, GraphQL, etc.

API_SPEC_VERSION: KeywordField = KeywordField('apiSpecVersion', 'apiSpecVersion') class-attribute

Version of the API specification.

APISpec

pyatlan.model.assets.a_p_i_spec.APISpec(__pydantic_self__, **data: Any)

Bases: API

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

API_PATHS: RelationField = RelationField('apiPaths') class-attribute

TBC

API_SPEC_CONTACT_EMAIL: KeywordTextField = KeywordTextField('apiSpecContactEmail', 'apiSpecContactEmail', 'apiSpecContactEmail.text') class-attribute

Email address for a contact responsible for the API specification.

API_SPEC_CONTACT_NAME: KeywordTextField = KeywordTextField('apiSpecContactName', 'apiSpecContactName.keyword', 'apiSpecContactName') class-attribute

Name of the contact responsible for the API specification.

API_SPEC_CONTACT_URL: KeywordTextField = KeywordTextField('apiSpecContactURL', 'apiSpecContactURL', 'apiSpecContactURL.text') class-attribute

URL pointing to the contact information.

API_SPEC_CONTRACT_VERSION: KeywordField = KeywordField('apiSpecContractVersion', 'apiSpecContractVersion') class-attribute

Version of the contract for the API specification.

API_SPEC_LICENSE_NAME: KeywordTextField = KeywordTextField('apiSpecLicenseName', 'apiSpecLicenseName.keyword', 'apiSpecLicenseName') class-attribute

Name of the license under which the API specification is available.

API_SPEC_LICENSE_URL: KeywordTextField = KeywordTextField('apiSpecLicenseURL', 'apiSpecLicenseURL', 'apiSpecLicenseURL.text') class-attribute

URL to the license under which the API specification is available.

API_SPEC_SERVICE_ALIAS: KeywordTextField = KeywordTextField('apiSpecServiceAlias', 'apiSpecServiceAlias', 'apiSpecServiceAlias.text') class-attribute

Service alias for the API specification.

API_SPEC_TERMS_OF_SERVICE_URL: KeywordTextField = KeywordTextField('apiSpecTermsOfServiceURL', 'apiSpecTermsOfServiceURL', 'apiSpecTermsOfServiceURL.text') class-attribute

URL to the terms of service for the API specification.

APIQuery

pyatlan.model.assets.a_p_i_query.APIQuery(__pydantic_self__, **data: Any)

Bases: API

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

API_FIELDS: RelationField = RelationField('apiFields') class-attribute

TBC

API_INPUT_FIELD_COUNT: NumericField = NumericField('apiInputFieldCount', 'apiInputFieldCount') class-attribute

Count of the APIField of this query that are input to it.

API_QUERY_OUTPUT_TYPE: KeywordField = KeywordField('apiQueryOutputType', 'apiQueryOutputType') class-attribute

Type of APIQueryOutput, as free text (e.g. STRING, NUMBER etc).

API_QUERY_OUTPUT_TYPE_SECONDARY: KeywordField = KeywordField('apiQueryOutputTypeSecondary', 'apiQueryOutputTypeSecondary') class-attribute

Secondary Type of APIQueryOutput (e.g. LIST/STRING then LIST would be the secondary type).

APIObject

pyatlan.model.assets.a_p_i_object.APIObject(__pydantic_self__, **data: Any)

Bases: API

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

API_FIELDS: RelationField = RelationField('apiFields') class-attribute

TBC

API_FIELD_COUNT: NumericField = NumericField('apiFieldCount', 'apiFieldCount') class-attribute

Count of the APIField of this object.

APIPath

pyatlan.model.assets.a_p_i_path.APIPath(__pydantic_self__, **data: Any)

Bases: API

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

API_PATH_AVAILABLE_OPERATIONS: KeywordField = KeywordField('apiPathAvailableOperations', 'apiPathAvailableOperations') class-attribute

List of the operations available on the endpoint.

API_PATH_AVAILABLE_RESPONSE_CODES: KeywordField = KeywordField('apiPathAvailableResponseCodes', 'apiPathAvailableResponseCodes') class-attribute

Response codes available on the path across all operations.

API_PATH_IS_INGRESS_EXPOSED: BooleanField = BooleanField('apiPathIsIngressExposed', 'apiPathIsIngressExposed') class-attribute

Whether the path is exposed as an ingress (true) or not (false).

API_PATH_IS_TEMPLATED: BooleanField = BooleanField('apiPathIsTemplated', 'apiPathIsTemplated') class-attribute

Whether the endpoint's path contains replaceable parameters (true) or not (false).

API_PATH_RAW_URI: KeywordTextField = KeywordTextField('apiPathRawURI', 'apiPathRawURI', 'apiPathRawURI.text') class-attribute

Absolute path to an individual endpoint.

API_PATH_SUMMARY: TextField = TextField('apiPathSummary', 'apiPathSummary') class-attribute

Descriptive summary intended to apply to all operations in this path.

API_SPEC: RelationField = RelationField('apiSpec') class-attribute

TBC

APIField

pyatlan.model.assets.a_p_i_field.APIField(__pydantic_self__, **data: Any)

Bases: API

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

API_FIELD_TYPE: KeywordField = KeywordField('apiFieldType', 'apiFieldType') class-attribute

Type of APIField, as free text (e.g. STRING, NUMBER etc).

API_FIELD_TYPE_SECONDARY: KeywordField = KeywordField('apiFieldTypeSecondary', 'apiFieldTypeSecondary') class-attribute

Secondary type of APIField (e.g. LIST/STRING, then LIST would be the secondary type).

API_OBJECT: RelationField = RelationField('apiObject') class-attribute

TBC

API_QUERY: RelationField = RelationField('apiQuery') class-attribute

TBC

API_QUERY_PARAM_TYPE: KeywordField = KeywordField('apiQueryParamType', 'apiQueryParamType') class-attribute

If parent relationship type is APIQuery, then this attribute denotes if this is input or output parameter.