OperationCatalog

object

The verbs this instance offers, as data. An agent discovers what it may ask the run endpoint for by reading this rather than by knowing the verbs in advance — which is why every field a caller needs in order to build a legal request is declared here.

• operationsarray

  • (each item)object

    • idstring

    • groupstring

    • labelstring

    • symbolstring

      Glyph name a picker draws beside the label — presentation metadata, stable per verb, from the app's shared icon set.

    • blurbstring

      One plain-text line for pickers. description is the reference text; this is the working surface's sentence.

    • descriptionstring

    • inputsarray

      The datasets this verb takes and what each is for. A verb with two inputs has two that are not interchangeable — a spatial join's left and right mean different things, and the output's geometry comes from one of them. A verb that declares none takes its input from whatever its own SQL names, which is a different thing from taking no input at all.

      • (each item)object

        • namestring

        • labelstring

        • descriptionstring

        • acceptsarray

          Geometry classes this particular input accepts. "none" is the opposite of "any": it admits only a table without geometry, which is what a verb that writes a geometry column onto every row takes.

          • (each item)string

            One of any, none, point, line, polygon

        • requiredboolean

    • acceptsarray

      Input geometry classes the operation accepts overall; "any" includes a table with no geometry, and "none" admits only one.

      • (each item)string

        One of any, none, point, line, polygon

    • requiresarray

      What this instance must be configured with for the verb to run at all. A verb that declares none always runs.

      • (each item)string

        One of geocoder, isochrone

    • availabilityobject

      Whether this instance can run the verb, resolved when the catalog is served rather than declared — an operator who configures a provider changes the answer without changing a verb. A verb with no requirement answers available.

      • availableboolean

      • reasonstringor null

        Why not, when it cannot — one sentence a reader can act on, naming the setting that is missing.

    • outputGeometryobject

      Where the result's geometry comes from. A verb that fixes its class regardless of input declares it; one that passes geometry through names the input it comes from; one whose result must be inspected says so.

      • kindstring

        One of probed, none, from_input, fixed

      • inputstring

      • geometrystring

        One of point, line, polygon

    • parametersarray

      • (each item)object

        • minnumber

          Hard lower bound, where the verb has one.

        • maxnumber

          Hard upper bound, where the verb has one.

        • namestring

        • typestring

          enum is one value from options; enum_list is several, as a list. They are distinct because a caller told enum where a list is required has been given the wrong shape. field is one column of the named input; column_list is several columns, as names; field_list is several aggregate specifications — {aggregate, field, as} — and sending one shape where the other is expected is refused.

          One of string, number, boolean, enum, enum_list, field, column_list, field_list, number_list

        • requiredboolean

        • descriptionstring

        • optionsarray of string

          The permitted values for an enum or enum list, fixed by the operation's own contract rather than by whatever the engine happens to offer. On a field_list these are the aggregates that parameter accepts, which differ between verbs.

        • aliasableboolean

          Whether a carried value may be given a name of its own. A summary's aggregates cannot, and an editor offering the field would produce a name the operation ignores.

        • requiredWhenobject

          What makes this parameter required, when it is not always — a distance is needed only for a within-distance relationship. Declared so a caller knows before it sends rather than after the refusal.

          • parameterstring

          • equalsstring

        • relevantWhenobject

          When this parameter is part of the question at all — absent means always; present, it only applies while the named parameter holds one of these values. A distance is no part of an "intersects" question. Distinct from requiredWhen: a parameter can be used without being required. A value sent for an inapplicable parameter is ignored or refused by the operation's own admission, so callers should omit it.

          • parameterstring

          • oneOfarray of string

        • ofInputstring

          Which input a field parameter names a column of.

        • fieldTypestring

          The kind of column a field parameter may name, when the verb needs one kind. Declared so a caller offers or sends a column that can work rather than learning from a refusal; admission checks the same rule.

          One of text, number

        • minItemsnumber

          For a number_list: the fewest items the list takes.

        • maxItemsnumber

          For a number_list: the most items the list takes — the isochrone's four bands is the protocol's own maximum.

        • itemMinnumber

          For a number_list: the floor every item must clear.

        • itemIntegerboolean

          For a number_list: items must be whole numbers.

        • itemsUniqueboolean

          For a number_list: duplicate items are refused — each band is asked once.

        • unitstring

          Present when the value is not a bare number: metres is a ground measurement — metres on the earth, at the latitude the data occupies, never degrees and never metres on a map projection; a caller that ignores this and sends the geometry's own units gets a buffer five hundred degrees wide. minutes is travel time: the number the user typed is the number on the wire, no conversion exists.

          One of metres, minutes

        • default

          The value used when the parameter is omitted.