@g1cloud/api-gen 1.0.0

package/test-output.yaml

@@ -0,0 +1,650 @@
+openapi: 3.0.0
+info:
+  title: API Documentation
+  version: 1.0.0
+tags:
+  - name: ProductController
+    description: "Product management REST controller\r\nDemonstrates additional features like @Secured and complex queries"
+  - name: UserController
+    description: User management REST controller
+paths:
+  /api/products:
+    get:
+      summary: Search Products
+      operationId: product_searchProducts
+      responses:
+        '200':
+          description: Successful response
+          headers:
+            X-Total-Count:
+              schema:
+                type: integer
+              description: Total number of items
+            X-Offset:
+              schema:
+                type: integer
+              description: Current offset
+            X-Limit:
+              schema:
+                type: integer
+              description: Current limit
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ProductDTO'
+      tags:
+        - ProductController
+      description: Search products with pagination
+      parameters:
+        - name: offset
+          in: query
+          schema:
+            type: integer
+          description: Pagination offset
+        - name: limit
+          in: query
+          schema:
+            type: integer
+          description: Pagination limit
+        - name: filter
+          in: query
+          schema:
+            $ref: '#/components/schemas/Filter'
+          description: Filter conditions
+        - name: sort
+          in: query
+          schema:
+            $ref: '#/components/schemas/Sort'
+          description: Sort conditions
+    post:
+      summary: Create Product
+      operationId: product_createProduct
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProductDTO'
+      tags:
+        - ProductController
+      description: "Create new product\r\nUsing @Secured annotation\n\n**Required Roles:** ROLE_ADMIN"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ProductDTO'
+      security:
+        - bearerAuth: []
+      x-required-roles:
+        - ROLE_ADMIN
+  /api/products/{id}:
+    get:
+      summary: Get Product By Id
+      operationId: product_getProductById
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProductDTO'
+      tags:
+        - ProductController
+      description: Get product by ID
+      parameters:
+        - name: id
+          in: path
+          schema:
+            type: integer
+            format: int64
+          required: true
+    put:
+      summary: Update Product
+      operationId: product_updateProduct
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProductDTO'
+      tags:
+        - ProductController
+      description: "Update product\r\nComplex security: admin can update any product, vendor can only update own products\n\n**Required Roles:** ROLE_ADMIN, ROLE_VENDOR\n\n**Security Expression:** `hasRole('ADMIN') or (hasRole('VENDOR') and @productService.isOwner(#id, authentication.principal.id))`"
+      parameters:
+        - name: id
+          in: path
+          schema:
+            type: integer
+            format: int64
+          required: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ProductDTO'
+      security:
+        - bearerAuth: []
+      x-required-roles:
+        - ROLE_ADMIN
+        - ROLE_VENDOR
+      x-security-expression: hasRole('ADMIN') or (hasRole('VENDOR') and @productService.isOwner(#id, authentication.principal.id))
+    delete:
+      summary: Delete Product
+      operationId: product_deleteProduct
+      responses:
+        '200':
+          description: Successful response
+      tags:
+        - ProductController
+      description: Delete product
+      parameters:
+        - name: id
+          in: path
+          schema:
+            type: integer
+            format: int64
+          required: true
+  /api/products/category/{categoryId}:
+    get:
+      summary: Get Products By Category
+      operationId: product_getProductsByCategory
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ProductDTO'
+      tags:
+        - ProductController
+      description: |-
+        Get products by category with price range filter
+
+        **Security Expression:** `isAuthenticated()`
+      parameters:
+        - name: categoryId
+          in: path
+          schema:
+            type: integer
+            format: int64
+          required: true
+        - name: minPrice
+          in: query
+          schema:
+            type: number
+        - name: maxPrice
+          in: query
+          schema:
+            type: number
+        - name: limit
+          in: query
+          schema:
+            type: integer
+            format: int32
+      x-security-expression: isAuthenticated()
+  /api/products/search:
+    get:
+      summary: Search Products By Name
+      operationId: product_searchProductsByName
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ProductDTO'
+      tags:
+        - ProductController
+      description: Search products by name (partial match)
+      parameters:
+        - name: query
+          in: query
+          schema:
+            type: string
+          required: true
+        - name: sortBy
+          in: query
+          schema:
+            type: string
+        - name: sortDirection
+          in: query
+          schema:
+            type: string
+  /api/products/bulk-price-update:
+    post:
+      summary: Bulk Update Prices
+      operationId: product_bulkUpdatePrices
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ProductDTO'
+      tags:
+        - ProductController
+      description: "Bulk update product prices\r\nVery complex security expression with multiple conditions\n\n**Required Roles:** ROLE_ADMIN\n\n**Security Expression:** `hasRole('ADMIN') and hasAuthority('BULK_OPERATIONS') and #request.size() <= 100`"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/PriceUpdateRequest'
+      security:
+        - bearerAuth: []
+      x-required-roles:
+        - ROLE_ADMIN
+      x-security-expression: 'hasRole(''ADMIN'') and hasAuthority(''BULK_OPERATIONS'') and #request.size() <= 100'
+  /api/users:
+    get:
+      summary: Search Users
+      operationId: user_searchUsers
+      responses:
+        '200':
+          description: Successful response
+          headers:
+            X-Total-Count:
+              schema:
+                type: integer
+              description: Total number of items
+            X-Offset:
+              schema:
+                type: integer
+              description: Current offset
+            X-Limit:
+              schema:
+                type: integer
+              description: Current limit
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/UserDTO'
+      tags:
+        - UserController
+      description: "Search users with pagination\r\nUses SearchParam for pagination and filtering\n\n**Required Roles:** ROLE_USER"
+      parameters:
+        - name: offset
+          in: query
+          schema:
+            type: integer
+          description: Pagination offset
+        - name: limit
+          in: query
+          schema:
+            type: integer
+          description: Pagination limit
+        - name: filter
+          in: query
+          schema:
+            $ref: '#/components/schemas/Filter'
+          description: Filter conditions
+        - name: sort
+          in: query
+          schema:
+            $ref: '#/components/schemas/Sort'
+          description: Sort conditions
+      security:
+        - bearerAuth: []
+      x-required-roles:
+        - ROLE_USER
+    post:
+      summary: Create User
+      operationId: user_createUser
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserDTO'
+      tags:
+        - UserController
+      description: |-
+        Create new user
+
+        **Required Roles:** ROLE_ADMIN
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateUserRequest'
+      security:
+        - bearerAuth: []
+      x-required-roles:
+        - ROLE_ADMIN
+  /api/users/{id}:
+    get:
+      summary: Get User By Id
+      operationId: user_getUserById
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserDTO'
+      tags:
+        - UserController
+      description: |-
+        Get user by ID
+
+        **Required Roles:** ROLE_USER, ROLE_ADMIN
+      parameters:
+        - name: id
+          in: path
+          schema:
+            type: integer
+            format: int64
+          required: true
+      security:
+        - bearerAuth: []
+      x-required-roles:
+        - ROLE_USER
+        - ROLE_ADMIN
+    put:
+      summary: Update User
+      operationId: user_updateUser
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserDTO'
+      tags:
+        - UserController
+      description: "Update existing user\r\nComplex security: admin can update anyone, users can only update themselves\n\n**Required Roles:** ROLE_ADMIN, ROLE_USER\n\n**Security Expression:** `hasRole('ADMIN') or (#id == authentication.principal.id and hasRole('USER'))`"
+      parameters:
+        - name: id
+          in: path
+          schema:
+            type: integer
+            format: int64
+          required: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateUserRequest'
+      security:
+        - bearerAuth: []
+      x-required-roles:
+        - ROLE_ADMIN
+        - ROLE_USER
+      x-security-expression: hasRole('ADMIN') or (#id == authentication.principal.id and hasRole('USER'))
+    delete:
+      summary: Delete User
+      operationId: user_deleteUser
+      responses:
+        '200':
+          description: Successful response
+      tags:
+        - UserController
+      description: |-
+        Delete user
+
+        **Required Roles:** ROLE_ADMIN
+      parameters:
+        - name: id
+          in: path
+          schema:
+            type: integer
+            format: int64
+          required: true
+      security:
+        - bearerAuth: []
+      x-required-roles:
+        - ROLE_ADMIN
+  /api/users/department/{departmentId}:
+    get:
+      summary: Get Users By Department
+      operationId: user_getUsersByDepartment
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/UserDTO'
+      tags:
+        - UserController
+      description: Get users by department with optional status filter
+      parameters:
+        - name: departmentId
+          in: path
+          schema:
+            type: integer
+            format: int64
+          required: true
+        - name: status
+          in: query
+          schema:
+            type: string
+        - name: X-Tenant-ID
+          in: header
+          schema:
+            type: string
+      security:
+        - bearerAuth: []
+  /api/users/bulk:
+    post:
+      summary: Bulk Import Users
+      operationId: user_bulkImportUsers
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/UserDTO'
+      tags:
+        - UserController
+      description: |-
+        Bulk import users
+
+        **Required Roles:** ROLE_ADMIN
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/CreateUserRequest'
+      security:
+        - bearerAuth: []
+      x-required-roles:
+        - ROLE_ADMIN
+components:
+  schemas:
+    Filter:
+      type: object
+      description: Filter conditions
+    Sort:
+      type: object
+      description: Sort conditions
+    SearchParam:
+      type: object
+      description: Search parameters for pagination and filtering
+      properties:
+        offset:
+          type: integer
+          description: Pagination offset
+        limit:
+          type: integer
+          description: Pagination limit
+        filter:
+          $ref: '#/components/schemas/Filter'
+        sort:
+          $ref: '#/components/schemas/Sort'
+    UpdateUserRequest:
+      type: object
+      properties:
+        firstName:
+          type: string
+        lastName:
+          type: string
+        email:
+          type: string
+          pattern: ^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$
+        phoneNumber:
+          type: string
+          pattern: ^\\+?[1-9]\\d{1,14}$
+        departmentId:
+          type: integer
+          format: int64
+        status:
+          type: string
+    CreateUserRequest:
+      type: object
+      properties:
+        firstName:
+          type: string
+        lastName:
+          type: string
+        email:
+          type: string
+          pattern: ^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$
+        password:
+          type: string
+        phoneNumber:
+          type: string
+          pattern: ^\\+?[1-9]\\d{1,14}$
+        departmentId:
+          type: integer
+          format: int64
+      required:
+        - firstName
+        - lastName
+        - email
+        - password
+        - departmentId
+    UserDTO:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        firstName:
+          type: string
+        lastName:
+          type: string
+        email:
+          type: string
+          pattern: ^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$
+        phoneNumber:
+          type: string
+          pattern: ^\\+?[1-9]\\d{1,14}$
+        status:
+          type: string
+        createdAt:
+          type: string
+          format: date-time
+        updatedAt:
+          type: string
+          format: date-time
+        department:
+          $ref: '#/components/schemas/DepartmentDTO'
+        roles:
+          type: array
+          items:
+            $ref: '#/components/schemas/RoleDTO'
+      required:
+        - firstName
+        - lastName
+        - email
+    RoleDTO:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        description:
+          type: string
+        permissions:
+          type: array
+          items:
+            type: string
+    DepartmentDTO:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        description:
+          type: string
+        code:
+          type: string
+    PriceUpdateRequest:
+      type: object
+      properties:
+        productId:
+          type: integer
+          format: int64
+        newPrice:
+          type: number
+    ProductDTO:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        description:
+          type: string
+        price:
+          type: number
+        stockQuantity:
+          type: integer
+          format: int32
+        sku:
+          type: string
+        category:
+          type: string
+        tags:
+          type: array
+          items:
+            type: string
+        active:
+          type: boolean
+        createdAt:
+          type: string
+          format: date-time
+        updatedAt:
+          type: string
+          format: date-time
+      required:
+        - name
+        - price
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT