flamingo.me/flamingo-commerce/v3@v3.11.0/commerce.go (about)

     1  package commerce
     2  
     3  /*
     4  	Flamingo Commerce Modules.
     5  	The subpackage represent Flamingo Commerce modules - please refer to the documentations for the individual modules.
     6  */
     7  
     8  //go:generate rm -rf docs/openapi
     9  //go:generate go run github.com/swaggo/swag/cmd/swag@v1.16.3 init -p pascalcase --generalInfo=commerce.go --dir=./ --output=docs/openapi
    10  
    11  // Swagger Documentation used for generator swag (https://github.com/swaggo/swag#declarative-comments-format)
    12  // @title Flamingo Commerce API Spec
    13  // @description Swagger (OpenAPI) Spec of all Flamingo Commerce modules
    14  // @version 1.0
    15  // @contact.name Flamingo
    16  // @contact.url https://gitter.im/i-love-flamingo/community#
    17  // @contact.email flamingo@aoe.com
    18  // @license.name MIT
    19  // @tag.name Cart
    20  // @tag.description All Cart related APIs endpoints, most suitable to be called from a browser, because they rely on the session and cookie headers.
    21  // @tag.name Payment
    22  // @tag.description All Payment related APIs endpoints, most suitable to be called from a browser, because they rely on the session and cookie headers.
    23  // @tag.name Product
    24  // @tag.description All Product related APIs endpoints.
    25  // @tag.name Checkout
    26  // @tag.description  All Checkout related APIs endpoints, most suitable to be called from a browser, because they rely on the session and cookie headers.