restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/api/RestconfSchemaService.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.restconf.nb.rfc8040.rests.services.api;
   9
  10 import javax.ws.rs.GET;
  11 import javax.ws.rs.Path;
  12 import javax.ws.rs.PathParam;
  13 import javax.ws.rs.Produces;
  14 import org.opendaylight.restconf.common.schema.SchemaExportContext;
  15 import org.opendaylight.yangtools.yang.common.YangConstants;
  16
  17 /**
  18  * Retrieval of the YANG modules which server supports.
  19  */
  20 @Path("/")
  21 public interface RestconfSchemaService {
  22     /**
  23      * Get schema of specific module.
  24      *
  25      * @param identifier path parameter
  26      * @return {@link SchemaExportContext}
  27      */
  28     @GET
  29     @Produces({ YangConstants.RFC6020_YIN_MEDIA_TYPE, YangConstants.RFC6020_YANG_MEDIA_TYPE })
  30     @Path("modules/{identifier:.+}")
  31     SchemaExportContext getSchema(@PathParam("identifier") String identifier);
  32 }