X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Fhoneycomb_url_files.rst;fp=docs%2Fhoneycomb_url_files.rst;h=4dfa10c516233c1f73a53503744f3ab610788daf;hp=0000000000000000000000000000000000000000;hb=3121b691debad27fcea1c6e2031e4a2544e42fbf;hpb=d9c35ed4fe07f506a8146cfc295d96049d5a76e9 diff --git a/docs/honeycomb_url_files.rst b/docs/honeycomb_url_files.rst new file mode 100644 index 0000000000..4dfa10c516 --- /dev/null +++ b/docs/honeycomb_url_files.rst @@ -0,0 +1,22 @@ +# Copyright (c) 2016 Cisco and/or its affiliates. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +Documentation to files used to store URLs to resources in Honeycomb. +==================================================================== + +A URL file is a text file encoded in utf-8 with a path to a resource in +Honeycomb. There is only one line in each file. + +The URL is stored without host and port with leading slash. There is no slash at +the end, e.g.: + /restconf/config/v3po:vpp/bridge-domains