-
Bug
-
Resolution: Done
-
Medium
-
Istanbul Release
-
None
-
None
In CPS project, docs/api/swagger/ncmp/openapi.yaml is a source code file that is added to source control and then it is not expected to be modified when the application is compiled.
Here is the diff generated after running mvn clean compile:
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index 0edce20..013e406 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -612,6 +612,53 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + /v1/ch/{cm-handle}/modules: + get: + tags: + - network-cm-proxy + summary: Fetch all module references (name and revision) for a given cm handle + description: fetch all module references (name and revision) for a given cm + handle + operationId: getModuleReferencesByCmHandle + parameters: + - name: cm-handle + in: path + description: "The identifier for a network function, network element, subnetwork\ + \ or any other cm object by managed Network CM Proxy" + required: true + schema: + type: string + responses: + "200": + description: OK + content: + application/json: + schema: + type: object + "400": + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + "401": + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + "403": + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + "404": + description: The specified resource was not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' components: schemas: ErrorMessage:
Beyond this issue, the role of this file needs to be clarified.
1. Is is a documentation file for read the docs as its location suggests ? If it is the case then:
- it should not be related to the application source code at all. Documentation is not part of cps 2.0.0 release then it can not contain any code related files.
- Any modification made on this file should not impact the buillt application. By being in docs directory, it should only have an impact on rtd documenatation.
2. Is it a source code file ? If it is the case then:
- it should be part of one of the maven modules that is released with the application
- It should not be modified when the application is compiled
- if the documentation needs to reference this file, a link to the repo (istanbul branch) can be made in rtd.
3. Is it a generated file ? If this is the case then:
- It should not be added to source control that should ignore it (by have it generated in a target directory)
- if the documentation needs to reference this file, a copy of the generated file for istanbul can be added in rtd docs directory.
The file should be only one of the 3, but can not be all 3 at the same time as it seems to be currently.
- is cloned by
-
CPS-709 DMI-Plugin openapi.yaml should not be modified when the application is compiled
- Closed