docs/honeycomb_url_files.rst

   1 # Copyright (c) 2016 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 Documentation to files used to store URLs to resources in Honeycomb.
  15 ====================================================================
  16
  17 A URL file is a text file encoded in utf-8 with a path to a resource in
  18 Honeycomb. There is only one line in each file.
  19
  20 The URL is stored without host and port with leading slash. There is no slash at
  21 the end, e.g.:
  22     /restconf/config/v3po:vpp/bridge-domains