catalog.config
==============

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionCall_parameters"> <div class="card"> <div class="card-header" id="headingCall_parameters"> <h2 class="mb-0"> <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters"> <div class="card-body pl-5"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value"> <div class="card"> <div class="card-header" id="headingReturn_value"> <h2 class="mb-0"> <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button> </h2> </div> <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value"> <div class="card-body pl-5"> <h4>CatalogEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_id"> <div class="card"> <div class="card-header" id="headingReturn_value_id"> <h2 class="mb-0"> <button aria-controls="Return_value_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id" data-toggle="collapse" onclick="setAnchor('#Return_value_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_id" id="Return_value_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Unique identifier for the catalog.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_id_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_label"> <div class="card"> <div class="card-header" id="headingReturn_value_label"> <h2 class="mb-0"> <button aria-controls="Return_value_label" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_label" data-toggle="collapse" onclick="setAnchor('#Return_value_label')" type="button"><span class="property-name">label</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_label" class="collapse property-definition-div" data-parent="#accordionReturn_value_label" id="Return_value_label"> <div class="card-body pl-5"> <h4>Label</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "nobody"</span><br/> <span class="description"><p>Catalog identifier. Must start with alphanumeric, then allow alphanumeric, periods, and hyphens.</p> </span><span class="pattern-value" id="Return_value_label_pattern">Must match regular expression: <code>^\w+[\w.-]*$</code></span> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_label_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_preferred_trains"> <div class="card"> <div class="card-header" id="headingReturn_value_preferred_trains"> <h2 class="mb-0"> <button aria-controls="Return_value_preferred_trains" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_preferred_trains" data-toggle="collapse" onclick="setAnchor('#Return_value_preferred_trains')" type="button"><span class="property-name">preferred_trains</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_preferred_trains" class="collapse property-definition-div" data-parent="#accordionReturn_value_preferred_trains" id="Return_value_preferred_trains"> <div class="card-body pl-5"> <h4>Preferred Trains</h4><span class="badge badge-dark value-type">Type: array of string</span><br/> <span class="description"><p>Array of preferred train names for this catalog.</p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Return_value_preferred_trains_items"> <span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_preferred_trains_items_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_location"> <div class="card"> <div class="card-header" id="headingReturn_value_location"> <h2 class="mb-0"> <button aria-controls="Return_value_location" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_location" data-toggle="collapse" onclick="setAnchor('#Return_value_location')" type="button"><span class="property-name">location</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_location" class="collapse property-definition-div" data-parent="#accordionReturn_value_location" id="Return_value_location"> <div class="card-body pl-5"> <h4>Location</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Git repository URL or local path to the catalog.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_location_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* CATALOG_READ

