API Specification Editing Interface for Automated Build Systems
Find Innovative SolutionsGenerate Solutions
Solution Overview
Problem
Development of web services and applications faces logistical challenges, particularly in coordinating efforts among multiple parties, as technical writers and software engineers often lack direct access to up-to-date API specification data, such as WADL or WSDL, which hinders efficient editing and updating of software development kit (SDK) documentation.
Innovation Solution
A method and system that allow controlled editing of API specification data in a user-friendly format, enabling direct access and updates to WADL or WSDL data, using software tools to convert between formats and provide editing interfaces, thereby integrating changes into an automated build process.
Engineering Contradictions & Design Principles
Engineering Contradiction Analysis
1Productivity
If technical writers and software engineers are given direct access to WADL or WSDL specification data, then editing efficiency and visibility of changes are improved, but the complexity of managing and coordinating edits among multiple parties increases
Solution Approach 1:
The patent introduces an intermediary system that sits between the specification data and the users (technical writers and software engineers). This intermediary provides a controlled interface that allows users to view and edit specification data without giving them direct access to the underlying WADL or WSDL files. The intermediary manages the complexity of coordination by handling version control, access permissions, and change propagation automatically, thus improving editing efficiency while preventing coordination chaos.
Solution Approach 2:
The patent creates a copy or representation of the specification data that is suitable for user editing. Instead of allowing direct access to the original WADL/WSDL files, the system generates an editable version or view that users can modify. This copying approach allows multiple users to work with the specification data simultaneously without risking corruption of the original files, while the system manages the synchronization of changes back to the source.
2Loss of information
If automated build processes are triggered frequently to reflect changes in SDK documentation, then documentation freshness is improved, but build time and computational resources are increased
Solution Approach 1:
The patent implements a periodic or event-driven build trigger mechanism rather than continuous building. Changes to specification data are detected and tracked, and automated builds are triggered only when necessary - specifically when changes are made that affect the SDK documentation. This periodic action ensures documentation remains fresh and up-to-date while avoiding unnecessary builds that would waste time and computational resources.
Solution Approach 2:
The system incorporates feedback mechanisms that monitor changes to specification data and automatically trigger builds only when relevant changes occur. The feedback loop tracks the state of specification files, identifies meaningful changes, and activates the automated build process accordingly. This feedback-driven approach maintains documentation freshness by ensuring builds occur when needed, while preventing unnecessary builds that would consume time and resources.
Data Source
AI summary
Development of network-based computing resources can be enhanced through the use of methods and systems that allow for controlled editing of specification data used in an automated build process in a user-friendly way. Particularly, one or more software tools can be used to allow editing of application programming interfaces (API) specification data such as Web Application Description Language (WADL) or Web Service Description Language (WSDL) and/or to allow editing of elements used to generate software development kit (SDK) documentation relied upon by an automatic build system. For example, a first interface may be configured for editing parameter values and parameter types related to functionality of the API while a second interface may restrict use to editing descriptive aspects of the API such as the SDK.