com.phoenixnap.oss.ramlapisync.annotations.data.PathDescription Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of springmvc-raml-annotations Show documentation

Optional custom annotations allowing behaviour to be defined that cannot be described within the standard SpringMVC annotations

There is a newer version: 0.10.14

Show newest version

/*
 * Copyright 2002-2017 the original author or authors.
 * 
 * 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 com.phoenixnap.oss.ramlapisync.annotations.data;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * A description that will be applied to part of the Path/ URL of an API
 * 
 * @author Kurt Paris
 * @since 0.0.1
 *
 */
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface PathDescription {
	
	/**
	 * The Partial url this will applied to
	 * 
	 * @return the partial url that the description with be applied to
	 */
	String key();
	
	/**
	 * Description that will be applied to the resource
	 * 
	 * @return String description that will be applied to the resource
	 */
	String value();
	
	
}