Discovery

Requirement: GET /{any}/docs REQ_INTEROP_002
status: verified
tags: Discovery
is verified by: TEST_CapabilityGeneratorTest_EntityCollectionDetailPathHasParameters, TEST_CapabilityGeneratorTest_GenerateEntityCollectionReturnsSpec, TEST_CapabilityGeneratorTest_GenerateInvalidPathReturnsNullopt, TEST_CapabilityGeneratorTest_GenerateRootContainsEntityCollections, TEST_CapabilityGeneratorTest_GenerateRootContainsEntityDetailPaths, TEST_CapabilityGeneratorTest_GenerateRootContainsGlobalFaults, TEST_CapabilityGeneratorTest_GenerateRootContainsHealthEndpoint, TEST_CapabilityGeneratorTest_GenerateRootContainsVersionInfo, TEST_CapabilityGeneratorTest_GenerateRootReturnsValidOpenApiSpec, TEST_DocsHandlersTest_DocsAnyPathReturns200ForEntityCollection, TEST_DocsHandlersTest_DocsAnyPathReturns404ForInvalidPath, TEST_DocsHandlersTest_DocsDisabledReturns501, TEST_DocsHandlersTest_DocsRootReturnsValidJson, TEST_OpenApiSpecBuilderTest_AlwaysIncludesGenericErrorResponse, TEST_OpenApiSpecBuilderTest_BuildContainsComponentsSchemas, TEST_OpenApiSpecBuilderTest_BuildContainsInfoBlock, TEST_OpenApiSpecBuilderTest_BuildContainsPathsObject, TEST_OpenApiSpecBuilderTest_BuildContainsServersArray, TEST_OpenApiSpecBuilderTest_BuildContainsSovdVersion, TEST_OpenApiSpecBuilderTest_BuildProducesOpenApi310Version, TEST_OpenApiSpecBuilderTest_FluentInterfaceChaining, TEST_OpenApiSpecBuilderTest_GenericErrorSchemaAlwaysPresent, TEST_OpenApiSpecBuilderTest_NonEmptySchemasArePresentInOutput, TEST_OpenApiSpecBuilderTest_SecuritySchemeAddsToComponents, TEST_PathBuilderTest_ActionOperationHasGetAndPost, TEST_PathBuilderTest_BulkDataHasGet, TEST_PathBuilderTest_ConfigurationsHasGetAndDelete, TEST_PathBuilderTest_CyclicSubscriptionsHasGetAndPost, TEST_PathBuilderTest_DataCollectionHasGet, TEST_PathBuilderTest_DataItemGetAlwaysPresent, TEST_PathBuilderTest_DataItemPutForSubscribeTopic, TEST_PathBuilderTest_EntityCollectionHasGet, TEST_PathBuilderTest_EntityDetailConcretePathOmitsParameters, TEST_PathBuilderTest_EntityDetailHasGet, TEST_PathBuilderTest_EntityDetailTemplatePathHasParameters, TEST_PathBuilderTest_ErrorResponsesWithoutAuth, TEST_PathBuilderTest_FaultsHasGetAndDelete, TEST_PathBuilderTest_LogsHasGet, TEST_PathBuilderTest_OperationsCollectionHasGet, TEST_PathBuilderTest_ServiceOperationHasGetAndPost, TEST_PathBuilderTest_SseEndpointHasGet, TEST_PathResolverTest_DeepNestedPath, TEST_PathResolverTest_EntityCollection, TEST_PathResolverTest_HostsIsResourceCollection, TEST_PathResolverTest_HostsUnderFunctionsIsResourceCollection, TEST_PathResolverTest_MultiSegmentResourceId, TEST_PathResolverTest_NestedEntityCollection, TEST_PathResolverTest_ResourceCollection, TEST_PathResolverTest_RootPath, TEST_PathResolverTest_SpecificEntity, TEST_PathResolverTest_SpecificResource, TEST_RouteDescriptionsTest_EmptyBuilderProducesEmptyDescriptions, TEST_RouteDescriptionsTest_MultipleEndpoints, TEST_RouteDescriptionsTest_PostWithRequestBody, TEST_RouteDescriptionsTest_SchemaTypes, TEST_RouteDescriptionsTest_SingleGetEndpoint, TEST_RouteRegistryTest_AuthEnabledAdds401And403Responses, TEST_RouteRegistryTest_ErrorResponsesUseGenericErrorRef, TEST_RouteRegistryTest_OperationIdIsGenerated, TEST_RouteRegistryTest_PathParamDescriptionsArePresent, TEST_RouteRegistryTest_ToOpenapiPathsContainsRegisteredRoute, TEST_RouteRegistryTest_ToOpenapiPathsMultipleMethodsSamePath, TEST_RouteRegistryTest_ToRegexPathRootBecomesRootAnchored, TEST_SchemaBuilderRuntimeTest_FromRosMsgKnownType, TEST_SchemaBuilderRuntimeTest_FromRosMsgUnknownType, TEST_SchemaBuilderStaticTest_AcquireLockRequestSchema, TEST_SchemaBuilderStaticTest_BulkDataCategoryListSchema, TEST_SchemaBuilderStaticTest_BulkDataDescriptorSchema, TEST_SchemaBuilderStaticTest_ConfigurationMetaDataSchema, TEST_SchemaBuilderStaticTest_ConfigurationMetaDataXMedkitDeclaresAllEmittedFields, TEST_SchemaBuilderStaticTest_ConfigurationReadValueSchema, TEST_SchemaBuilderStaticTest_ConfigurationWriteValueSchema, TEST_SchemaBuilderStaticTest_CyclicSubscriptionCreateRequestSchema, TEST_SchemaBuilderStaticTest_DataWriteRequestSchema, TEST_SchemaBuilderStaticTest_ExecutionUpdateRequestSchema, TEST_SchemaBuilderStaticTest_ExtendLockRequestSchema, TEST_SchemaBuilderStaticTest_LogConfigurationSchemaFieldsOptional, TEST_SchemaBuilderStaticTest_OperationDetailSchema, TEST_SchemaBuilderStaticTest_ScriptControlRequestSchema, TEST_SchemaBuilderStaticTest_ScriptUploadResponseSchema, TEST_SchemaBuilderStaticTest_TriggerConditionSchemaShared, TEST_SchemaBuilderStaticTest_TriggerCreateRequestSchema, TEST_SchemaBuilderStaticTest_TriggerUpdateRequestSchema, TEST_SchemaConsistencyTest_AllRefsResolveToRegisteredSchemas, TEST_SchemaConsistencyTest_ListSchemasReferenceExistingItemSchemas, TEST_SchemaConsistencyTest_RequiredFieldsExistInProperties, TEST_TestDocsEndpoint_test_apps_docs_returns_entity_collection_spec, TEST_TestDocsEndpoint_test_areas_docs_returns_entity_collection_spec, TEST_TestDocsEndpoint_test_components_docs_returns_entity_collection_spec, TEST_TestDocsEndpoint_test_data_collection_docs, TEST_TestDocsEndpoint_test_logs_configuration_schema_field_names, TEST_TestDocsEndpoint_test_nonexistent_entity_docs_returns_404, TEST_TestDocsEndpoint_test_nonexistent_path_docs_returns_404, TEST_TestDocsEndpoint_test_operations_collection_docs, TEST_TestDocsEndpoint_test_root_docs_returns_openapi_spec, TEST_TestDocsEndpoint_test_spec_contains_components, TEST_TestDocsEndpoint_test_spec_contains_server_info, TEST_TestDocsEndpoint_test_specific_app_docs, TEST_TestHealth_test_docs_endpoint, TEST_TestHealth_test_docs_spec_completeness, TEST_TestOpenApiCallability_test_all_endpoints_accept_spec_requests, TEST_TestOpenApiResponseDrift_test_configurations_payload_uses_nested_x_medkit, TEST_TestOpenApiResponseDrift_test_get_responses_match_declared_schema, TEST_TestOpenApiResponseDrift_test_update_status_payload_uses_nested_x_medkit

The endpoint shall provide human- and machine-readable documentation of the addressed resource and its capabilities.
Requirement: GET /{entity-collection} REQ_INTEROP_003
status: verified
tags: Discovery
is verified by: TEST_AggregationClassification_hierarchical_parent_drops_routing_across_multiple_peers, TEST_AggregationClassification_hierarchical_parent_drops_routing_when_local_subcomponents_exist, TEST_AggregationClassification_hierarchical_parent_drops_routing_when_remote_subcomponents_exist, TEST_AggregationClassification_leaf_collision_across_multiple_peers_emits_warning, TEST_AggregationClassification_leaf_collision_keeps_routing_to_peer, TEST_AggregationClassification_leaf_collision_routing_respects_input_order, TEST_AggregationClassification_parent_references_nonexistent_component_falls_back_to_leaf, TEST_AggregationClassification_self_parent_is_ignored_and_warned, TEST_AggregationClassification_subcomponents_of_hierarchical_parent_still_route_to_peer, TEST_AggregationClassification_two_way_parent_cycle_falls_back_to_leaves_with_warning, TEST_AggregationManager_fan_out_returns_partial_when_peers_unreachable, TEST_AggregationManager_forward_returns_502_for_unknown_peer, TEST_AggregationManager_forward_strips_peer_prefix_from_path, TEST_AggregationManager_routing_table_update_and_find, TEST_AppModelTest_ToJson_ContainsRequiredFields, TEST_AreaModelTest_ToJson_ContainsRequiredFields, TEST_CgroupReader_CgroupV1FormatNotSupported, TEST_CgroupReader_DetectRuntime, TEST_CgroupReader_ExtractContainerdContainerId, TEST_CgroupReader_ExtractDockerContainerId, TEST_CgroupReader_ExtractDockerOldStyleContainerId, TEST_CgroupReader_ExtractNoContainerId, TEST_CgroupReader_ExtractPodmanContainerId, TEST_CgroupReader_IsContainerizedSyntheticProc, TEST_CgroupReader_ReadCgroupInfoMissingCgroupFile, TEST_CgroupReader_ReadCgroupInfoMissingResourceFiles, TEST_CgroupReader_ReadCgroupInfoUnlimitedResources, TEST_CgroupReader_ReadCgroupInfoWithResourceLimits, TEST_ComponentModelTest_ToJson_ContainsRequiredFields, TEST_ContainerPlugin_CgroupInfoToJsonAllFields, TEST_ContainerPlugin_CgroupInfoToJsonMissingOptionals, TEST_ContainerPlugin_NotContainerizedSkipped, TEST_DiscoveryHandlersFixtureTest_GetAppReturnsLinksAndCapabilities, TEST_DiscoveryHandlersFixtureTest_GetAppUnknownIdReturns404, TEST_DiscoveryHandlersFixtureTest_GetAreaReturnsCapabilitiesAndLinks, TEST_DiscoveryHandlersFixtureTest_GetAreaUnknownIdReturns404, TEST_DiscoveryHandlersFixtureTest_GetComponentReturnsRelationshipsAndCapabilities, TEST_DiscoveryHandlersFixtureTest_GetFunctionReturnsCapabilitiesAndGraphLink, TEST_DiscoveryHandlersFixtureTest_GetFunctionUnknownIdReturns404, TEST_DiscoveryHandlersFixtureTest_ListAppsReturnsSeededMetadata, TEST_DiscoveryHandlersFixtureTest_ListAreasReturnsSeededItems, TEST_DiscoveryHandlersFixtureTest_ListComponentsReturnsMetadata, TEST_DiscoveryHandlersFixtureTest_ListFunctionsReturnsSeededFunctions, TEST_DiscoveryHandlersValidationTest_GetAppInvalidIdReturns400, TEST_DiscoveryHandlersValidationTest_GetAreaInvalidIdReturns400, TEST_DiscoveryHandlersValidationTest_GetAreaMissingMatchesReturns400, TEST_DiscoveryHandlersValidationTest_GetComponentInvalidIdReturns400, TEST_DiscoveryHandlersValidationTest_GetFunctionInvalidIdReturns400, TEST_EntityMerger_apps_collision_prefixed_gets_peer_contributor_only, TEST_EntityMerger_apps_collision_sets_original_id, TEST_EntityMerger_apps_prefix_on_collision, TEST_EntityMerger_areas_merge_by_id, TEST_EntityMerger_builds_routing_table_for_remote_entities, TEST_EntityMerger_components_collision_appends_peer_contributor, TEST_EntityMerger_components_merge_by_id, TEST_EntityMerger_components_remote_only_gets_peer_contributor_only, TEST_EntityMerger_contributors_no_duplicate_on_repeat_merge, TEST_EntityMerger_functions_merge_by_id_combining_hosts, TEST_EntityMerger_merged_component_hybrid_synthetic_collision_routes_to_peer, TEST_EntityMerger_multi_peer_overlapping_app_ids_no_data_loss, TEST_FunctionModelTest_ToJson_ContainsRequiredFields, TEST_FunctionResourceCollections_AreaSupportsFaults, TEST_FunctionResourceCollections_FunctionChildAppIds, TEST_FunctionResourceCollections_FunctionDataAggregatesFromHostedApps, TEST_FunctionResourceCollections_FunctionSupportsFaults, TEST_GapFillConfigTest_DefaultAllowsAll, TEST_GapFillConfigTest_NamespaceBlacklistFiltersAreas, TEST_GapFillConfigTest_NamespaceWhitelistFiltersAreas, TEST_GraphProviderPluginRouteTest_RegistersFunctionCapabilityOnContext, TEST_GraphProviderPluginRouteTest_RegistersSamplerForCyclicSubscriptions, TEST_GraphProviderPluginRouteTest_ServesFunctionGraphFromCachedSnapshot, TEST_HostInfoProviderTest_creates_default_component, TEST_HostInfoProviderTest_sanitizes_hostname_to_valid_entity_id, TEST_ManifestLayerTest_DefaultPolicies, TEST_MdnsDiscovery_default_config_values, TEST_MdnsDiscovery_instance_name_returns_explicit_name, TEST_MdnsDiscovery_respects_announce_flag, TEST_MdnsDiscovery_start_announce_on_ephemeral_port_does_not_crash, TEST_MergePipelineTest_AppStatusMerge_BoolOrSemantics, TEST_MergePipelineTest_LayerExceptionDoesNotCrashPipeline, TEST_MergePipelineTest_PluginReceivesDiscoveryContext, TEST_MergePipelineTest_ThreeLayerMerge_PerFieldGroupOwnerTracking, TEST_MergePipelineTest_ThreeLayerMerge_PluginEnrichesManifestEntity, TEST_MergeTypesTest_MergePolicyValues, TEST_PeerClientHappyPath_fetch_entities_parses_collections, TEST_PeerClientHappyPath_fetch_entities_parses_relationship_fields, TEST_PeerClientHappyPath_forward_request_rejects_oversized_response, TEST_PeerClient_fetch_entities_returns_error_on_connection_refused, TEST_PeerClient_forward_sets_502_on_connection_error, TEST_PidCacheTest_AutoRefreshOnTTLExpiry, TEST_PidCacheTest_ConcurrentLookupDoesNotCrash, TEST_PidCacheTest_EmptyProcDir, TEST_PidCacheTest_LookupAfterRefresh, TEST_PidCacheTest_LookupMissingNode, TEST_PidCacheTest_LookupRootNamespaceNode, TEST_PidCacheTest_NoRefreshWithinTTL, TEST_PidCacheTest_NonexistentProcDir, TEST_PluginLayerTest_DefaultPolicies, TEST_ProcReader_ReadNonexistentPidFails, TEST_ProcReader_ReadSelfProcess, TEST_ProcReader_ReadSystemUptime, TEST_ProcReader_ReadSystemUptimeMissingFile, TEST_ProcReader_StateFieldPopulated, TEST_ProcfsPlugin_ProcessInfoToJsonAllFields, TEST_ProcfsPlugin_ProcessInfoToJsonNegativeUptimeClamped, TEST_ProcfsPlugin_ProcessInfoToJsonZeroUptime, TEST_RuntimeDiscoveryMultiNsTest_DiscoverFunctions_GroupsByNamespace, TEST_RuntimeDiscoveryTest_DiscoverFunctions_DefaultCreatesFromNamespaces, TEST_RuntimeLayerTest_DefaultPolicies, TEST_RuntimeLinkerTest_ExactMatch_NodeNameAndNamespace, TEST_RuntimeLinkerTest_OrphanPolicy_IncludeAsOrphan_NoError, TEST_RuntimeLinkerTest_OrphanPolicy_Warn_NoError, TEST_SyntheticProcTest_EmptyStatFile, TEST_SyntheticProcTest_FindPidForNodeInSyntheticProc, TEST_SyntheticProcTest_MalformedStatMissingComm, TEST_SyntheticProcTest_ReadSyntheticProc, TEST_SyntheticProcTest_ReadSystemUptimeSynthetic, TEST_SyntheticProcTest_TruncatedStatAfterComm, TEST_SystemdUtils_ComponentEndpointEmptyUnitsArray, TEST_SystemdUtils_EscapeAtSignInTemplateUnit, TEST_SystemdUtils_EscapeDotInServiceExtension, TEST_SystemdUtils_EscapeEmptyString, TEST_SystemdUtils_EscapeHyphenInUnitName, TEST_SystemdUtils_EscapeSimpleServiceName, TEST_SystemdUtils_EscapeSlashInPath, TEST_TestContainerAppEndpoint_test_all_apps_same_container, TEST_TestContainerAppEndpoint_test_container_id_is_64_char_hex, TEST_TestContainerAppEndpoint_test_cpu_quota_detected, TEST_TestContainerAppEndpoint_test_memory_limit_detected, TEST_TestContainerAppEndpoint_test_returns_container_info, TEST_TestContainerAppEndpoint_test_runtime_is_docker, TEST_TestContainerComponentEndpoint_test_containers_include_node_ids, TEST_TestContainerComponentEndpoint_test_containers_include_runtime, TEST_TestContainerComponentEndpoint_test_returns_containers_aggregation, TEST_TestContainerErrorHandling_test_nonexistent_app_returns_404, TEST_TestContainerErrorHandling_test_nonexistent_component_returns_404, TEST_TestDaisyChainAggregation_test_primary_forwards_ecu_b_detail_one_hop, TEST_TestDaisyChainAggregation_test_primary_forwards_ecu_c_detail_two_hops, TEST_TestDaisyChainAggregation_test_primary_sees_all_ecus_as_subcomponents_of_robot_x, TEST_TestDaisyChainAggregation_test_primary_serves_robot_x_detail_locally_with_contributors, TEST_TestEntityListing_test_function_detail_accessible, TEST_TestEntityListing_test_list_areas_empty_in_runtime_mode, TEST_TestEntityListing_test_list_components, TEST_TestEntityListing_test_list_functions, TEST_TestEntityModelRuntime_test_app_is_located_on_endpoint, TEST_TestEntityModelRuntime_test_apps_linked_to_default_component, TEST_TestEntityModelRuntime_test_areas_empty_in_runtime_mode, TEST_TestEntityModelRuntime_test_default_component_detail, TEST_TestEntityModelRuntime_test_default_component_from_host, TEST_TestEntityModelRuntime_test_function_detail_shows_namespace_source, TEST_TestEntityModelRuntime_test_function_hosts_apps, TEST_TestEntityModelRuntime_test_multiple_apps_same_component, TEST_TestEntityModelRuntime_test_namespaces_create_functions, TEST_TestEntityRouting_test_app_routes_work_with_app_id, TEST_TestEntityRouting_test_component_route_rejects_app_id_configurations, TEST_TestEntityRouting_test_component_route_rejects_app_id_data, TEST_TestEntityRouting_test_component_route_rejects_app_id_faults, TEST_TestEntityRouting_test_component_route_rejects_app_id_operations, TEST_TestFlatEntityTree_test_app_accessible_without_areas, TEST_TestFlatEntityTree_test_apps_count, TEST_TestFlatEntityTree_test_areas_empty, TEST_TestFlatEntityTree_test_components_count, TEST_TestFlatEntityTree_test_functions_count, TEST_TestFlatEntityTree_test_subcomponents_count, TEST_TestGatewayNode_test_list_areas_endpoint, TEST_TestGatewayNode_test_list_components_endpoint, TEST_TestHateoas_test_app_detail_has_capability_uris, TEST_TestHateoas_test_apps_list_has_href, TEST_TestHateoas_test_area_detail_has_capability_uris, TEST_TestHateoas_test_areas_list_has_href, TEST_TestHateoas_test_component_detail_has_capability_uris, TEST_TestHateoas_test_components_list_has_href, TEST_TestHateoas_test_function_detail_has_capability_uris, TEST_TestHateoas_test_functions_list_has_href, TEST_TestHateoas_test_x_medkit_extension_in_list_responses, TEST_TestHybridSuppression_test_exact_app_count, TEST_TestHybridSuppression_test_exact_area_count, TEST_TestHybridSuppression_test_exact_component_count, TEST_TestHybridSuppression_test_exact_function_count, TEST_TestHybridSuppression_test_health_shows_hybrid_mode, TEST_TestHybridSuppression_test_manifest_apps_are_online, TEST_TestHybridSuppression_test_no_root_or_synthetic_areas, TEST_TestHybridSuppression_test_no_underscored_app_duplicates, TEST_TestHybridSuppression_test_no_underscored_component_duplicates, TEST_TestLeafCollisionAggregation_test_health_surfaces_leaf_collision_with_both_peers, TEST_TestLeafCollisionAggregation_test_shared_leaf_resolves_to_exactly_one_peer, TEST_TestScenarioDiscoveryHybrid_test_01_areas_from_manifest, TEST_TestScenarioDiscoveryHybrid_test_02_area_with_description, TEST_TestScenarioDiscoveryHybrid_test_05_components_from_manifest, TEST_TestScenarioDiscoveryHybrid_test_06_component_type_preserved, TEST_TestScenarioDiscoveryHybrid_test_14_apps_from_manifest, TEST_TestScenarioDiscoveryHybrid_test_15_app_online_with_runtime_node, TEST_TestScenarioDiscoveryHybrid_test_20_functions_from_manifest, TEST_TestScenarioDiscoveryManifest_test_01_list_areas, TEST_TestScenarioDiscoveryManifest_test_02_get_area_details, TEST_TestScenarioDiscoveryManifest_test_06_list_components, TEST_TestScenarioDiscoveryManifest_test_07_get_component_details, TEST_TestScenarioDiscoveryManifest_test_11_list_apps, TEST_TestScenarioDiscoveryManifest_test_12_get_app_details, TEST_TestScenarioDiscoveryManifest_test_15_app_data_endpoint, TEST_TestScenarioDiscoveryManifest_test_17_app_configurations_endpoint, TEST_TestScenarioDiscoveryManifest_test_18_app_data_item_endpoint, TEST_TestScenarioDiscoveryManifest_test_19_list_functions, TEST_TestScenarioDiscoveryManifest_test_20_get_function_details, TEST_TestSystemdAppEndpoint_test_returns_restart_count, TEST_TestSystemdAppEndpoint_test_returns_unit_info, TEST_TestSystemdAppEndpoint_test_returns_unit_type, TEST_TestSystemdAppEndpoint_test_returns_watchdog_usec, TEST_TestSystemdComponentEndpoint_test_returns_units_aggregation, TEST_TestSystemdComponentEndpoint_test_units_have_active_state, TEST_TestSystemdComponentEndpoint_test_units_include_node_ids, TEST_TestSystemdErrorHandling_test_nonexistent_app_returns_404, TEST_TestSystemdErrorHandling_test_nonexistent_component_returns_404, TEST_XMedkitTest_ContributorsOmitsFieldWhenInputEmpty, TEST_XMedkitTest_ContributorsPlacesLocalFirstThenPeersAlphabeticallyFromReverseInput, TEST_XMedkitTest_ContributorsWithoutLocalStaysAlphabetical

The endpoint shall list all entities of the requested collection together with their basic metadata.
Requirement: tags=... (query) REQ_INTEROP_011
status: verified
tags: Discovery
is verified by: TEST_TestScenarioDiscoveryHybrid_test_24_function_with_tags

The server shall support tag-based query parameters that filter discovery responses by tags.