gateway-service-definitions/src/main/resources/services/hbase/0.98.0/service.xml

<!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You 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.
-->
<service role="WEBHBASE" name="webhbase" version="0.98.0">
    <metadata>
        <type>API</type>
        <context>/hbase</context>
        <shortDesc>Web HBase</shortDesc>
        <description>The HBase REST server exposes endpoints that provide CRUD (create, read, update, delete) operations for each HBase process, as well as tables, regions, and namespaces.</description>
        <samples>
            <sample>
                <description>List all namespaces</description>
                <method>GET</method>
                <path>namespaces</path>
            </sample>
            <sample>
                <description>Describe a specific namespace</description>
                <method>GET</method>
                <path>namespaces/special_ns</path>
            </sample>
            <sample>
                <description>Create a new namespace</description>
                <method>POST</method>
                <path>namespaces/special_ns</path>
            </sample>
            <sample>
                <description>Delete a namespace. The namespace must be empty.</description>
                <method>DELETE</method>
                <path>namespaces/special_ns</path>
            </sample>
            <sample>
                <description>You may check out Apache Web HBase's REST API documentation here</description>
                <value>https://hbase.apache.org/book.html#_using_rest_endpointsl</value>
            </sample>
        </samples>
    </metadata>
    <routes>
        <route path="/hbase/?**">
            <rewrite apply="WEBHBASE/webhbase/headers/outbound" to="response.headers"/>
        </route>
        <route path="/hbase/**?**">
            <rewrite apply="WEBHBASE/webhbase/headers/outbound" to="response.headers"/>
        </route>
        <route path="/hbase/status/cluster?**">
            <rewrite apply="WEBHBASE/webhbase/status/outbound" to="response.body"/>
        </route>
        <route path="/hbase/*/regions?**">
            <rewrite apply="WEBHBASE/webhbase/regions/outbound" to="response.body"/>
        </route>
    </routes>

    <testURLs>
        <testURL>/hbase/version</testURL>
        <testURL>/hbase/version/cluster</testURL>
        <testURL>/hbase/status/cluster</testURL>
        <testURL>/hbase</testURL>
    </testURLs>
</service>