Academic Observatory API
latest
Contents:
Deploy the API with Terraform
Academic Observatory API
API Reference
Academic Observatory API
»
Index
Edit on GitHub
Index
_
|
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
_
__call__() (academic_observatory_api.client.api_client.Endpoint method)
__call_api() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
__contains__() (academic_observatory_api.client.model_utils.ModelComposed method)
(academic_observatory_api.client.model_utils.ModelNormal method)
(academic_observatory_api.client.model_utils.ModelSimple method)
__copy__() (academic_observatory_api.client.model_utils.OpenApiModel method)
__deepcopy__() (academic_observatory_api.client.Configuration method)
(academic_observatory_api.client.configuration.Configuration method)
(academic_observatory_api.client.model_utils.OpenApiModel method)
__enter__() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
__eq__() (academic_observatory_api.client.model_utils.ModelComposed method)
(academic_observatory_api.client.model_utils.ModelNormal method)
(academic_observatory_api.client.model_utils.ModelSimple method)
__exit__() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
__gather_params() (academic_observatory_api.client.api_client.Endpoint method)
__get__() (academic_observatory_api.client.model_utils.cached_property method)
__getattr__() (academic_observatory_api.client.model_utils.OpenApiModel method)
__getitem__() (academic_observatory_api.client.model_utils.ModelComposed method)
(academic_observatory_api.client.model_utils.ModelNormal method)
(academic_observatory_api.client.model_utils.ModelSimple method)
__ne__() (academic_observatory_api.client.model_utils.OpenApiModel method)
__repr__() (academic_observatory_api.client.model_utils.OpenApiModel method)
__setattr__() (academic_observatory_api.client.Configuration method)
(academic_observatory_api.client.configuration.Configuration method)
(academic_observatory_api.client.model_utils.OpenApiModel method)
__setitem__() (academic_observatory_api.client.model_utils.ModelComposed method)
(academic_observatory_api.client.model_utils.ModelNormal method)
(academic_observatory_api.client.model_utils.ModelSimple method)
__str__() (academic_observatory_api.client.ApiException method)
(academic_observatory_api.client.exceptions.ApiException method)
__unset_attribute_value__ (academic_observatory_api.client.model_utils.ModelComposed attribute)
__validate_inputs() (academic_observatory_api.client.api_client.Endpoint method)
__version__ (in module academic_observatory_api.client)
_apply_auth_params() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
_base_path (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
_composed_schemas (academic_observatory_api.client.model.pit_response.PitResponse attribute)
(academic_observatory_api.client.model.query_response.QueryResponse attribute)
_default (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
_from_openapi_data() (academic_observatory_api.client.model.pit_response.PitResponse class method)
(academic_observatory_api.client.model.query_response.QueryResponse class method)
_new_from_openapi_data() (academic_observatory_api.client.model_utils.OpenApiModel class method)
_nullable (academic_observatory_api.client.model.pit_response.PitResponse attribute)
(academic_observatory_api.client.model.query_response.QueryResponse attribute)
_pool (academic_observatory_api.client.api_client.ApiClient attribute)
(academic_observatory_api.client.ApiClient attribute)
A
academic_observatory_api
module
academic_observatory_api.client
module
academic_observatory_api.client.api
module
academic_observatory_api.client.api.academic_observatory_api
module
academic_observatory_api.client.api_client
module
academic_observatory_api.client.configuration
module
academic_observatory_api.client.exceptions
module
academic_observatory_api.client.model
module
academic_observatory_api.client.model.pit_response
module
academic_observatory_api.client.model.query_response
module
academic_observatory_api.client.model_utils
module
academic_observatory_api.client.rest
module
academic_observatory_api.client.test
module
academic_observatory_api.client.test.test_academic_observatory_api
module
academic_observatory_api.client.test.test_pit_response
module
academic_observatory_api.client.test.test_query_response
module
academic_observatory_api.server
module
academic_observatory_api.server.api
module
academic_observatory_api.server.app
module
academic_observatory_api.server.elastic
module
academic_observatory_api.server.tests
module
academic_observatory_api.server.utils
module
academic_observatory_api.tests
module
academic_observatory_api.tests.test_openapi_renderer
module
AcademicObservatoryApi (class in academic_observatory_api.client.api.academic_observatory_api)
additional_properties_type (academic_observatory_api.client.model.pit_response.PitResponse attribute)
(academic_observatory_api.client.model.query_response.QueryResponse attribute)
agg_field (academic_observatory_api.server.elastic.ElasticsearchIndex property)
agg_mappings (academic_observatory_api.server.elastic.ElasticsearchIndex property)
allowed_values (academic_observatory_api.client.model.pit_response.PitResponse attribute)
(academic_observatory_api.client.model.query_response.QueryResponse attribute)
allows_single_value_input() (in module academic_observatory_api.client.model_utils)
ApiAttributeError
,
[1]
ApiClient (class in academic_observatory_api.client)
(class in academic_observatory_api.client.api_client)
APIError
ApiException
,
[1]
ApiKeyError
,
[1]
ApiTypeError
,
[1]
ApiValueError
,
[1]
app (in module academic_observatory_api.server.app)
assert_hostname (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
attempt_convert_item() (in module academic_observatory_api.client.model_utils)
attribute_map (academic_observatory_api.client.model.pit_response.PitResponse attribute)
(academic_observatory_api.client.model.query_response.QueryResponse attribute)
auth_settings() (academic_observatory_api.client.Configuration method)
(academic_observatory_api.client.configuration.Configuration method)
C
cached_property (class in academic_observatory_api.client.model_utils)
call_api() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
call_with_http_info() (academic_observatory_api.client.api_client.Endpoint method)
cert_file (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
change_keys_js_to_python() (in module academic_observatory_api.client.model_utils)
check_allowed_values() (in module academic_observatory_api.client.model_utils)
check_validations() (in module academic_observatory_api.client.model_utils)
close() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
COERCIBLE_TYPE_PAIRS (in module academic_observatory_api.client.model_utils)
COERCION_INDEX_BY_TYPE (in module academic_observatory_api.client.model_utils)
composed_model_input_classes() (in module academic_observatory_api.client.model_utils)
config (in module academic_observatory_api.server.app)
Configuration (class in academic_observatory_api.client)
(class in academic_observatory_api.client.configuration)
connection_pool_maxsize (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
convert_js_args_to_python_args() (in module academic_observatory_api.client.model_utils)
create_es_connection() (in module academic_observatory_api.server.utils)
create_search_body() (in module academic_observatory_api.server.utils)
D
debug (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.Configuration property)
(academic_observatory_api.client.configuration.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration property)
DELETE() (academic_observatory_api.client.rest.RESTClientObject method)
deserialize() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
deserialize_file() (in module academic_observatory_api.client.model_utils)
deserialize_model() (in module academic_observatory_api.client.model_utils)
deserialize_primitive() (in module academic_observatory_api.client.model_utils)
discriminator() (academic_observatory_api.client.model.pit_response.PitResponse method)
(academic_observatory_api.client.model.query_response.QueryResponse method)
E
ElasticsearchIndex (class in academic_observatory_api.server.elastic)
Endpoint (class in academic_observatory_api.client.api_client)
F
file_type (in module academic_observatory_api.client.model_utils)
files_parameters() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
ForbiddenException
G
get() (academic_observatory_api.client.model_utils.ModelComposed method)
(academic_observatory_api.client.model_utils.ModelNormal method)
(academic_observatory_api.client.model_utils.ModelSimple method)
GET() (academic_observatory_api.client.rest.RESTClientObject method)
get_allof_instances() (in module academic_observatory_api.client.model_utils)
get_anyof_instances() (in module academic_observatory_api.client.model_utils)
get_api_key_with_prefix() (academic_observatory_api.client.Configuration method)
(academic_observatory_api.client.configuration.Configuration method)
get_basic_auth_token() (academic_observatory_api.client.Configuration method)
(academic_observatory_api.client.configuration.Configuration method)
get_default_copy() (academic_observatory_api.client.Configuration class method)
(academic_observatory_api.client.configuration.Configuration class method)
get_discarded_args() (in module academic_observatory_api.client.model_utils)
get_discriminated_classes() (in module academic_observatory_api.client.model_utils)
get_discriminator_class() (in module academic_observatory_api.client.model_utils)
get_file_data_and_close_file() (academic_observatory_api.client.api_client.ApiClient static method)
(academic_observatory_api.client.ApiClient static method)
get_host_from_settings() (academic_observatory_api.client.Configuration method)
(academic_observatory_api.client.configuration.Configuration method)
get_host_settings() (academic_observatory_api.client.Configuration method)
(academic_observatory_api.client.configuration.Configuration method)
get_oneof_instance() (in module academic_observatory_api.client.model_utils)
get_pit_id() (in module academic_observatory_api.server.elastic)
get_possible_classes() (in module academic_observatory_api.client.model_utils)
get_required_type_classes() (in module academic_observatory_api.client.model_utils)
get_simple_class() (in module academic_observatory_api.client.model_utils)
get_type_error() (in module academic_observatory_api.client.model_utils)
get_valid_classes_phrase() (in module academic_observatory_api.client.model_utils)
getheader() (academic_observatory_api.client.rest.RESTResponse method)
getheaders() (academic_observatory_api.client.rest.RESTResponse method)
H
HEAD() (academic_observatory_api.client.rest.RESTClientObject method)
host (academic_observatory_api.client.Configuration property)
(academic_observatory_api.client.configuration.Configuration property)
I
in_ipv4net() (in module academic_observatory_api.client.rest)
invalid_combinations (academic_observatory_api.server.elastic.ElasticsearchIndex property)
is_ipv4() (in module academic_observatory_api.client.rest)
is_json_validation_enabled() (in module academic_observatory_api.client.model_utils)
is_type_nullable() (in module academic_observatory_api.client.model_utils)
is_valid_type() (in module academic_observatory_api.client.model_utils)
J
JSON_SCHEMA_VALIDATION_KEYWORDS (in module academic_observatory_api.client.configuration)
K
key_file (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
L
list_available_index_dates() (in module academic_observatory_api.server.utils)
logger (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
(in module academic_observatory_api.client.rest)
logger_file (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.Configuration property)
(academic_observatory_api.client.configuration.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration property)
logger_file_handler (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
logger_format (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.Configuration property)
(academic_observatory_api.client.configuration.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration property)
logger_stream_handler (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
M
model_to_dict() (in module academic_observatory_api.client.model_utils)
ModelComposed (class in academic_observatory_api.client.model_utils)
ModelNormal (class in academic_observatory_api.client.model_utils)
ModelSimple (class in academic_observatory_api.client.model_utils)
module
academic_observatory_api
academic_observatory_api.client
academic_observatory_api.client.api
academic_observatory_api.client.api.academic_observatory_api
academic_observatory_api.client.api_client
academic_observatory_api.client.configuration
academic_observatory_api.client.exceptions
academic_observatory_api.client.model
academic_observatory_api.client.model.pit_response
academic_observatory_api.client.model.query_response
academic_observatory_api.client.model_utils
academic_observatory_api.client.rest
academic_observatory_api.client.test
academic_observatory_api.client.test.test_academic_observatory_api
academic_observatory_api.client.test.test_pit_response
academic_observatory_api.client.test.test_query_response
academic_observatory_api.server
academic_observatory_api.server.api
academic_observatory_api.server.app
academic_observatory_api.server.elastic
academic_observatory_api.server.tests
academic_observatory_api.server.utils
academic_observatory_api.tests
academic_observatory_api.tests.test_openapi_renderer
module_file_path() (in module academic_observatory_api.tests.test_openapi_renderer)
N
name (academic_observatory_api.server.elastic.ElasticsearchIndex property)
none_type (in module academic_observatory_api.client.model_utils)
NotFoundException
O
openapi_spec_path (in module academic_observatory_api.server.app)
openapi_types() (academic_observatory_api.client.model.pit_response.PitResponse method)
(academic_observatory_api.client.model.query_response.QueryResponse method)
OpenApiException
,
[1]
OpenApiModel (class in academic_observatory_api.client.model_utils)
OPTIONS() (academic_observatory_api.client.rest.RESTClientObject method)
order_response_types() (in module academic_observatory_api.client.model_utils)
P
parameters_to_multipart() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
parameters_to_tuples() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
parse_args() (in module academic_observatory_api.server.utils)
password (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
PATCH() (academic_observatory_api.client.rest.RESTClientObject method)
pit_id_agg() (academic_observatory_api.client.api.academic_observatory_api.AcademicObservatoryApi method)
(in module academic_observatory_api.server.api)
pit_id_subagg() (academic_observatory_api.client.api.academic_observatory_api.AcademicObservatoryApi method)
(in module academic_observatory_api.server.api)
PitResponse (class in academic_observatory_api.client.model.pit_response)
pool (academic_observatory_api.client.api_client.ApiClient property)
(academic_observatory_api.client.ApiClient property)
POST() (academic_observatory_api.client.rest.RESTClientObject method)
PRIMITIVE_TYPES (in module academic_observatory_api.client.model_utils)
process_response() (in module academic_observatory_api.server.utils)
proxy (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
proxy_headers (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
PUT() (academic_observatory_api.client.rest.RESTClientObject method)
Q
query_agg() (academic_observatory_api.client.api.academic_observatory_api.AcademicObservatoryApi method)
(in module academic_observatory_api.server.api)
query_elasticsearch() (in module academic_observatory_api.server.elastic)
query_subagg() (academic_observatory_api.client.api.academic_observatory_api.AcademicObservatoryApi method)
(in module academic_observatory_api.server.api)
QueryResponse (class in academic_observatory_api.client.model.query_response)
R
read_only_vars (academic_observatory_api.client.model.pit_response.PitResponse attribute)
(academic_observatory_api.client.model.query_response.QueryResponse attribute)
refresh_api_key_hook (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
remove_uncoercible() (in module academic_observatory_api.client.model_utils)
render_path() (in module academic_observatory_api.client.exceptions)
request() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
(academic_observatory_api.client.rest.RESTClientObject method)
required_properties (academic_observatory_api.client.model.pit_response.PitResponse attribute)
(academic_observatory_api.client.model.query_response.QueryResponse attribute)
Response (in module academic_observatory_api.server.api)
RESTClientObject (class in academic_observatory_api.client.rest)
RESTResponse (class in academic_observatory_api.client.rest)
result_key (academic_observatory_api.client.model_utils.cached_property attribute)
retries (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
S
safe_chars_for_path_param (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
sanitize_for_serialization() (academic_observatory_api.client.api_client.ApiClient class method)
(academic_observatory_api.client.ApiClient class method)
select_header_accept() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
select_header_content_type() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
server_operation_index (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
server_operation_variables (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
ServiceException
session_ (in module academic_observatory_api.server.api)
set_alias() (academic_observatory_api.server.elastic.ElasticsearchIndex method)
set_attribute() (academic_observatory_api.client.model_utils.OpenApiModel method)
set_default() (academic_observatory_api.client.Configuration class method)
(academic_observatory_api.client.configuration.Configuration class method)
set_default_header() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
setUp() (academic_observatory_api.client.test.test_academic_observatory_api.TestAcademicObservatoryApi method)
(academic_observatory_api.client.test.test_pit_response.TestPitResponse method)
(academic_observatory_api.client.test.test_query_response.TestQueryResponse method)
(academic_observatory_api.tests.test_openapi_renderer.TestOpenApiSchema method)
should_bypass_proxies() (in module academic_observatory_api.client.rest)
ssl_ca_cert (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
subagg_field (academic_observatory_api.server.elastic.ElasticsearchIndex property)
subagg_mappings (academic_observatory_api.server.elastic.ElasticsearchIndex property)
T
tearDown() (academic_observatory_api.client.test.test_academic_observatory_api.TestAcademicObservatoryApi method)
(academic_observatory_api.client.test.test_pit_response.TestPitResponse method)
(academic_observatory_api.client.test.test_query_response.TestQueryResponse method)
temp_folder_path (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
test_pit_id_agg() (academic_observatory_api.client.test.test_academic_observatory_api.TestAcademicObservatoryApi method)
test_pit_id_subagg() (academic_observatory_api.client.test.test_academic_observatory_api.TestAcademicObservatoryApi method)
test_query_agg() (academic_observatory_api.client.test.test_academic_observatory_api.TestAcademicObservatoryApi method)
test_query_subagg() (academic_observatory_api.client.test.test_academic_observatory_api.TestAcademicObservatoryApi method)
test_validate_api_client() (academic_observatory_api.tests.test_openapi_renderer.TestOpenApiSchema method)
test_validate_backend() (academic_observatory_api.tests.test_openapi_renderer.TestOpenApiSchema method)
test_validate_cloud_endpoints() (academic_observatory_api.tests.test_openapi_renderer.TestOpenApiSchema method)
TestAcademicObservatoryApi (class in academic_observatory_api.client.test.test_academic_observatory_api)
TestOpenApiSchema (class in academic_observatory_api.tests.test_openapi_renderer)
TestPitResponse (class in academic_observatory_api.client.test.test_pit_response)
testPitResponse() (academic_observatory_api.client.test.test_pit_response.TestPitResponse method)
TestQueryResponse (class in academic_observatory_api.client.test.test_query_response)
testQueryResponse() (academic_observatory_api.client.test.test_query_response.TestQueryResponse method)
to_debug_report() (academic_observatory_api.client.Configuration method)
(academic_observatory_api.client.configuration.Configuration method)
to_dict() (academic_observatory_api.client.model_utils.ModelComposed method)
(academic_observatory_api.client.model_utils.ModelNormal method)
to_str() (academic_observatory_api.client.model_utils.ModelComposed method)
(academic_observatory_api.client.model_utils.ModelNormal method)
(academic_observatory_api.client.model_utils.ModelSimple method)
type_error_message() (in module academic_observatory_api.client.model_utils)
U
UnauthorizedException
UPCONVERSION_TYPE_PAIRS (in module academic_observatory_api.client.model_utils)
update_params_for_auth() (academic_observatory_api.client.api_client.ApiClient method)
(academic_observatory_api.client.ApiClient method)
user_agent (academic_observatory_api.client.api_client.ApiClient property)
(academic_observatory_api.client.ApiClient property)
username (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)
V
validate_and_convert_types() (in module academic_observatory_api.client.model_utils)
validate_get_composed_info() (in module academic_observatory_api.client.model_utils)
validations (academic_observatory_api.client.model.pit_response.PitResponse attribute)
(academic_observatory_api.client.model.query_response.QueryResponse attribute)
verify_ssl (academic_observatory_api.client.Configuration attribute)
(academic_observatory_api.client.configuration.Configuration attribute)