Challenge Overview
Introduction
Welcome to the Actian Btrieve Challenge #3 - Build API Swagger Specification.
Actian is the hybrid data management, integration, and analytics company that enables enterprises to seamlessly manage and connect operational and analytic data for superior performance, insights, and business outcomes. Activate Your Data™ - Learn more about Actian’s products here and follow us on Twitter.
Overview
We had earlier run a challenge on the Topcoder community to build a sample app leveraging the Btrieve2 API. The winning submission from this challenge is attached in the forums. See this link for more details on the Btrieve2 API.
Btrieve is a transactional database engine that supports CRUD operations on records stored in indexed sequential access method (ISAM) files. For more information, see the Wikipedia articles for the Architecture of Btrieve and Btrieve, as well as the Zen/PSQL documentation at docs.actian.com. If you have deep technical questions about Btrieve or PSQL, please post in the forums at communities.actian.com. For challenge-related and lighter technical questions, please post in the Topcoder forum for this challenge.
Requirements
-
Build Swagger spec for Btrieve2 API based on the details provided below ( https://swagger.io/specification/ )
-
Make sure to include appropriate models as part of your Swagger
-
Make sure that your Swagger handles error cases for each endpoint as applicable
Deliverables
-
Swagger specification
Submission/Review
-
Submit your zipped swagger specification
-
The requests and responses should properly list all fields.
-
For responses, you should cover all the cases, not just 200 status code, like 404
-
Descriptions should be properly written for APIs, request input and responses etc
-
You can use editor.swagger.io for validation.
-
Create some sample body request for each API paths
-
The submissions will be scored by the Actian team in its sole discretion. There will be no appeals or appeals responses.
Scorecard
All submissions will be scored on a scale of 1-10 based on the following criteria:
-
Completeness of Swagger spec for Btrieve2 API. Feel free to add additional developer notes/ other documentation that my aid the review
Additional Terms and Conditions for All Participants
By participating in this competition, you acknowledge and agree to the following:
-
You must comply with all applicable laws in submitting a Competition Submission, and you represent that you are authorized to submit the Competition Submission.
-
Actian Corporation (“Actian”) is free to use, disclose, distribute or otherwise exploit Residual Knowledge. Residual Knowledge means information that is retained in the unaided memories of Actian’s employees and contractors who have had access to any Competition Submissions submitted by You. An employee’s or contractor’s memory will be considered unaided if the employee or contractor has not intentionally memorized the information for the purpose of retaining and subsequently using or disclosing it.
-
If you provide comments, criticism, suggested improvements, test results, answers to questions, and other feedback regarding the function, features, and other characteristics of the Actian products in written or oral form (“Feedback”), you agree that all Feedback is the property of Actian and may be used, reproduced, adapted, modified, distributed, and otherwise exploited by Actian in any manner and for any purpose.
-
You are not entitled to any compensation from Actian or any of the benefits which Actian may make available to its employees, and you are not authorized to make any representation, contract, or commitment on behalf of Actian.
-
Employees and direct and indirect subcontractors of Actian Corporation and its subsidiaries and other affiliates, and employees and direct and indirect subcontractors of Actian’s partners (including TopCoder and its affiliates) are not eligible to participate in the challenge.
-
You may only use data that is open and that can be shared with anyone in the world and which is freely available and to which you have rights to use the data.