Skip to content

Operations

AFI defines four core operations. All four are required at Level 2 conformance; providers at lower levels omit some.

Operation Purpose Required at
stat Metadata for one path Level 0+
list Directory contents Level 0+
read File contents Level 1+
search Locate strings/patterns/vectors across the tree Level 2+

Level 3 (mutation) adds write, mkdir, delete, move — deferred to AEP-0002.

Common conventions

All operations share these conventions:

  • Paths are POSIX-style absolute paths. See Path model.
  • Errors are structured per Errors.
  • Pagination uses opaque cursor strings. Providers MUST make cursors stable for the lifetime of a session but MAY invalidate them across sessions.
  • Unknown fields on responses MUST be tolerated by clients.