diff --git a/README.md b/README.md index 250d77d..a003176 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A minimal Spring Boot REST API used to test the **SpecShield GitHub Integration** end-to-end. -## What This Project Tests +## What This Project Tests : Updated2 | Test Case | Scenario | Expected SpecShield Result | |-----------|----------|---------------------------| diff --git a/openapi.yaml b/openapi.yaml deleted file mode 100644 index 0e9206b..0000000 --- a/openapi.yaml +++ /dev/null @@ -1,124 +0,0 @@ -openapi: "3.0.0" - -info: - title: SpecShield Test API - description: Sample User Management API for testing SpecShield GitHub Integration - version: "1.0.0" - contact: - name: SpecShield - url: https://specshield.io - -servers: - - url: http://localhost:8080 - description: Local development - -paths: - /users: - get: - summary: Get all users - operationId: listUsers - tags: [Users] - responses: - "200": - description: List of users returned successfully - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/User' - - post: - summary: Create a new user - operationId: createUser - tags: [Users] - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateUserRequest' - responses: - "201": - description: User created successfully - content: - application/json: - schema: - $ref: '#/components/schemas/User' - "400": - description: Invalid request body - - /users/{id}: - get: - summary: Get user by ID - operationId: getUserById - tags: [Users] - parameters: - - name: id - in: path - required: true - description: Unique user ID - schema: - type: integer - responses: - "200": - description: User found - content: - application/json: - schema: - $ref: '#/components/schemas/User' - "404": - description: User not found - - delete: - summary: Delete a user - operationId: deleteUser - tags: [Users] - parameters: - - name: id - in: path - required: true - schema: - type: integer - responses: - "204": - description: User deleted successfully - "404": - description: User not found - -components: - schemas: - User: - type: object - required: - - id - - name - - email - properties: - id: - type: integer - example: 1 - name: - type: string - example: "Alice Smith" - email: - type: string - format: email - example: "alice@example.com" - createdAt: - type: string - format: date-time - - CreateUserRequest: - type: object - required: - - name - - email - properties: - name: - type: string - example: "Alice Smith" - email: - type: string - format: email - example: "alice@example.com"