Fast Ref / API Reference / Query

get_outdated_references()

Download Markdown

Returns only the references whose source files have changed (OUTDATED). v2 new method.

Signature

api.get_outdated_references() -> dict

Return Value

{
    "success": True,
    "data": [
        {
            "slot": int,
            "name": str,
            "namespace": str,
            "file_path": str,
        },
        ...
    ]
}

An empty data list means all references are up to date.

Example

from os_fast_ref.api import FastRefAPI

api = FastRefAPI()
outdated = api.get_outdated_references()

if not outdated['data']:
    print("All references are up to date.")
else:
    for r in outdated['data']:
        print(f"  [{r['slot']}] {r['name']} — source file changed")

Usage Example — Check OUTDATED Then Reload

from os_fast_ref.api import FastRefAPI

api = FastRefAPI()
outdated = api.get_outdated_references()

if outdated['data']:
    result = api.reload_outdated_references()
    print(f"Reload complete: {result['success_count']} succeeded")

Note: check_file_status() returns status for all references, while get_outdated_references() returns only OUTDATED ones. For automated pipelines that only need to detect changes, the latter is more efficient.


💬

Need help with the API?

Open a support ticket or join the community discussion.

Contact Support