Interface DslApi

  • All Superinterfaces:
    ApiService

    @Path("/api/v1/dsl")
    public interface DslApi
    extends ApiService
    Operations with release DSL.
    • Method Detail

      • serviceName

        default java.lang.String serviceName()
        Specified by:
        serviceName in interface ApiService
      • previewExportTemplateToXFile

        @GET
        @Path("/preview/{templateId:.*Release[^/]*}")
        @Produces("text/plain")
        javax.ws.rs.core.Response previewExportTemplateToXFile​(@PathParam("templateId")
                                                               java.lang.String templateId,
                                                               @QueryParam("exportTemplate")
                                                               boolean asTemplate)
        Shows a DSL preview of a given template.
        Parameters:
        templateId - the template identifier.
        asTemplate - if true, will render as template, otherwise will render as release.
        Returns:
        UTF-8 encoded DSL string
      • exportTemplateToXFile

        @GET
        @Path("/export/{templateId:.*Release[^/]*}")
        @Produces("application/octet-stream")
        javax.ws.rs.core.Response exportTemplateToXFile​(@PathParam("templateId")
                                                        java.lang.String templateId,
                                                        @QueryParam("exportTemplate")
                                                        boolean asTemplate)
        Exports given template into DSL.
        Parameters:
        templateId - the template identifier.
        asTemplate - if true, will render as template, otherwise will render as release.
        Returns:
        a zip file with the DSL and attachments if the template contains them
      • exportTemplate

        java.lang.String exportTemplate​(Release template)
        Exports template as DSL.
        Parameters:
        template - template to export
        Returns:
        DSL string
      • exportTemplate

        java.lang.String exportTemplate​(Release template,
                                        boolean asTemplate)