blob: f7268532521918896ff4c2626db9f9d74199f391 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
/*
* Copyright 2015 Open Networking Laboratory
*
* 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.
*/
package org.onosproject.rest;
import com.google.common.annotations.Beta;
import java.util.Set;
/**
* Service for registering REST API documentation resources.
*/
@Beta
public interface ApiDocService {
/**
* Registers the specified REST API documentation provider.
*
* @param provider REST API documentation provider
*/
void register(ApiDocProvider provider);
/**
* Unregisters the specified REST API documentation provider.
*
* @param provider REST API documentation provider
*/
void unregister(ApiDocProvider provider);
/**
* Returns the set of all registered REST API documentation providers.
*
* @return set of registered documentation providers
*/
Set<ApiDocProvider> getDocProviders();
/**
* Returns the specified REST API documentation provider with the specified
* key.
*
* @param key REST API key
* @return documentation provider
*/
ApiDocProvider getDocProvider(String key);
}
|
