Configuration file editor with intelligent code-based interface and visual interface
An intelligent editor for creating a pipeline configuration file. The pipeline configuration file can be a YAML configuration file or in some other data serialization language. The intelligent editor is in the form of a YAML editor that provides multiple user interfaces for editing a pipeline configuration file. The YAML editor includes a code-based editing UI to edit the YAML configuration file code itself, and a visual-based editor UI for creating and modifying the configuration file through using graphical icons. The code-based editor UI includes an intelligent field and value recommendation feature, auto-complete feature, a semantic error detection feature, and a field documentation feature. The configuration file created and modified in the YAML editor can be based on a schema generated from one or more microservice schemas.
1. A method for modifying a pipeline configuration file, comprising:
receiving, by a YAML editor module executing on a first server, a plurality of schemas from a plurality microservices, at least one of the plurality of schemas having a first format;
merging multiple schemas derived from the received schemas into a single stitched schema;
receiving input, from a user through a YAML user interface, to modify a YAML file, the YAML user interface providing and allowing a user to edit the YAML file through both of a YAML code editor and a visual interface based on graphical icons, the graphical icons graphically representing pipelines, pipeline phases, and steps within a pipeline phase;
retrieving, by the YAML editor module, custom field values associated with the received input, the custom field values retrieved at least in part from the single stitched schema
semantically validating the input against the single stitched schema to determine one or more semantic validation errors;
displaying an indication of the one or more semantic validation errors to the user;
providing the custom field values in the UI to the user; and
inserting one of the custom field values into the YAML file within the UI based on a user selection of the custom field values.
2. The method of claim 1 , wherein at least one of the microservices is implemented on a second server.
3. The method of claim 1 , wherein the first format is a SWAGGER schema.
4. The method of claim 1 , wherein the YAML file is a YAML pipeline configuration file.
5. The method of claim 1 , wherein the YAML user interface includes a first interface for modifying the YAML configuration file in code form and a second interface for modifying the YAML configuration file through a graphical interface that includes the graphical icons.
6. The method of claim 1 , further comprising:
receiving a selection, from the user through the user interface, to edit the YAML configuration file in a visual interface;
providing the visual interface through the user interface;
providing a graphical representation of the YAML configuration file through the visual interface; and
modifying the YAML configuration file based on modifications to the graphical representation made in the visual interface in response to user input received through the visual interface.
7. The method of claim 1 ,
wherein the indication of the one or more semantic validation errors includes a highlight in the code editor and a corresponding semantic validation error graphical icon in the graphical user interface, wherein both the code editor highlight and the semantic validation error graphical icon represent the same indication of the one or more semantic validation errors.
8. The method of claim 1 , further including:
receiving input to select an entity of the YAML configuration file; and
displaying documentation for the selected entity within the YAML editor.
9. The method of claim 1 , further comprising pre-populating child properties of a selected field completion into the YAML file.
10. A non-transitory computer readable storage medium having embodied thereon a program, the program being executable by a processor to perform a method for modifying a pipeline configuration file, the method comprising:
receiving, by a YAML editor module executing on a first server, a plurality of schemas from a plurality microservices, at least one of the plurality of schemas having a first format;
merging multiple schemas derived from the received schemas into a single stitched schema;
receiving input, from a user through a YAML user interface, to modify a YAML file, the YAML user interface providing and allowing a user to edit the YAML file through both of a YAML code editor and a visual interface based on graphical icons, the graphical icons graphically representing pipelines, pipeline phases, and steps within a pipeline phase;
retrieving, by the YAML editor module, custom field values associated with the received input, the custom field values retrieved at least in part from the single stitched schema;
semantically validating the input against the single stitched schema to determine one or more semantic validation errors;
displaying an indication of the one or more semantic validation errors to the user;
providing the custom field values in the UI to the user; and
inserting one of the custom field values into the YAML file within the UI based on a user selection of the custom field values.
11. The non-transitory computer readable storage medium of claim 10 , wherein at least one of the microservices is implemented on a second server.
12. The non-transitory computer readable storage medium of claim 10 , wherein the first format is a SWAGGER schema.
13. The non-transitory computer readable storage medium of claim 10 , wherein the YAML file is a YAML pipeline configuration file.
14. The non-transitory computer readable storage medium of claim 10 , wherein the YAML user interface includes a first interface for modifying the YAML configuration file in code form and a second interface for modifying the YAML configuration file through a graphical interface that includes the graphical icons.
15. The non-transitory computer readable storage medium of claim 10 , further comprising:
receiving a selection, from the user through the user interface, to edit the YAML configuration file in a visual interface;
providing the visual interface through the user interface;
providing a graphical representation of the YAML configuration file through the visual interface; and
modifying the YAML configuration file based on modifications to the graphical representation made in the visual interface in response to user input received through the visual interface.
16. The non-transitory computer readable storage medium of claim 10 ,
wherein the indication of the one or more semantic validation errors includes a highlight in the code editor and a corresponding semantic validation error graphical icon in the graphical user interface, wherein both the code editor highlight and the semantic validation error graphical icon represent the same indication of the one or more semantic validation errors.
17. The non-transitory computer readable storage medium of claim 10 , further including:
receiving input to select an entity of the YAML configuration file; and
displaying documentation for the selected entity within the YAML editor.
18. The non-transitory computer readable storage medium of claim 10 , further comprising pre-populating child properties of a selected field completion into the YAML file.
19. A system for modifying a pipeline configuration file, comprising:
a server including a memory and a processor; and
one or more modules stored in the memory and executed by the processor to receive, by a YAML editor module executing on a first server, a plurality of schemas from a plurality microservices, at least one of the plurality of schemas having a first format, merge multiple schemas derived from the received schemas into a single stitched schema, receiving input, from a user through a YAML user interface, to modify a YAML file, the YAML user interface providing and allowing a user to edit the YAML file through both of a YAML code editor and a visual interface based on graphical icons, the graphical icons graphically representing pipelines, pipeline phases, and steps within a pipeline phase, retrieve, by the YAML editor module, custom field values associated with the received input, the custom field values retrieved at least in part from the single stitched schema, provide the custom field values in the UI to the user, insert one of the custom field values into the YAML file within the UI based on a user selection of the custom field values.
20. The system of claim 19 , wherein the YAML user interface includes a first interface for modifying the YAML configuration file in code form and a second interface for modifying the YAML configuration file through a graphical interface that includes the graphical icons.