ods-api-service/api-project-component-v0/openapi/api-project-component-v0.yaml at eba646804e16f96d69cadb84e09168713624266a · opendevstack/ods-api-service · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
openapi: 3.0.3
info:
  title: ODS API Server
  description: API documentation for ODS (Open DevStack) API Service
  contact:
    name: ODS Team
  version: v0.0.1
servers:
  - url: http://{baseurl}/api/pub/v0
    variables:
      baseurl:
        default: localhost:8080
        description: Development environment
tags:
  - name: Project Components
    description: API for managing project components

paths:
  /projects/{projectId}/components/:
    post:
      tags:
        - Project Components
      summary: Create a component in a project
      operationId: createProjectComponent
      description: Retrieves information about a specific component
      parameters:
        - name: projectId
          in: path
          required: true
          description: Project id
          schema:
            type: string
      requestBody:
        description: Component data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComponentRequest'
      responses:
        '201':
          description: Created
          headers:
            Location:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComponentResponse'
        '400':
          description: Bad Request
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          description: Forbidden
        '404':
          description: Endpoint not found / Project not found / Product not found
        '500':
          description: Internal Server Error

  /projects/{projectId}/components/{componentId}:
    get:
      tags:
        - Project Components
      summary: Get component information
      operationId: getProjectComponent
      description: Retrieves information about a specific component
      parameters:
        - name: projectId
          in: path
          required: true
          description: Project id
          schema:
            type: string
        - name: componentId
          in: path
          required: true
          description: Component id
          schema:
            type: string
      responses:
        '200':
          description: Component information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Component'

components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  responses:
    UnauthorizedError:
      description: Authentication information is missing or invalid
      headers:
        WWW_Authenticate:
          schema:
            type: string
  schemas:
    Component:
      type: object
      properties:
        id:
          type: string
          description: Component ID
        name:
          type: string
          description: Name of the component
        productDescription:
          type: string
          description: Description of the product
        productName:
          type: string
          description: Name of the product (e.g. Docker plain)
        productId:
          type: string
          description: Product ID
        environment:
          type: string
          description: Environment (e.g. DEV)
        status:
          type: string
          description: Status of the component (e.g. READY, NOT_READY)
        resultTraceback:
          type: string
          description: Traceback information in case of error
        repositoryURL:
          type: string
          description: URL of the repository (for ODS products)
        params:
          type: object
          description: Additional parameters (key-value pairs)
        component-type:
          type: string
          description: Type of component (ods|awx)
    CreateComponentResponse:
      type: object
      properties:
        errorCode:
          type: integer
        field:
          type: string
        message:
          type: string
        location:
          type: string
          format: url
    CreateComponentRequest:
      type: object
      properties:
        name:
          type: string
          description: component name
        productId:
          type: string
          description: product id
        params:
          type: object
          additionalProperties:
            type: string