-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ed21599
commit b2570ec
Showing
12 changed files
with
181 additions
and
177 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta http-equiv="refresh" content="0; url={{ page.target }}" /> | ||
| </head> | ||
|
|
||
| <body class="{{page.bodyClass}} {{layout.bodyClass}}"></body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,4 @@ | ||
| --- | ||
| layout: default | ||
| title: "Documentation" | ||
| layout: redirect | ||
| target: "/pages/documentation/general-introduction" | ||
| --- | ||
|
|
||
| <h1>Welcome to <span class="highlite">RestApia</span> Documentation</h1> | ||
|
|
||
| <div> | ||
| Welcome to the Documentation! Here, you'll find step-by-step guides, tips, and | ||
| resources | ||
| </div> | ||
| <div>to help you navigate and get the most out of the app.</div> | ||
|
|
||
| <div class="blocks" style="margin-top: 50px;"> | ||
| <div class="block"> | ||
| <h2>Start here</h2> | ||
| <ol> | ||
| <li><a href="/pages/pricing">Begin your journey for Free</a></li> | ||
| <li><a href="/pages/get-started">Get started with RestApia</a></li> | ||
| <li><a href="/pages/ni">Try out your first request</a></li> | ||
| <li><a href="/pages/ni">Code Syntax for Requests</a></li> | ||
| <li><a href="/pages/ni">Managing Collections with Git</a></li> | ||
| </ol> | ||
| </div> | ||
|
|
||
| <div class="block"> | ||
| <h2>Additional links</h2> | ||
| <ul> | ||
| <li><a href="/pages/docs/how-to-report-bug">How to report a Bug?</a></li> | ||
| <li><a href="/pages/docs/how-to-request-feature">Sending Feature Requests</a></li> | ||
| <li><a href="https://github.com/RestApia/RestApia.Community/issues/1">Our Upcoming Roadmap</a></li> | ||
| <li><a href="https://discord.gg/FZuQyEpYM4" target="_blank">Community in Discord</a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| <h1 style="margin-top: 50px;">Coming soon....</h1> | ||
| <div>We've got more features and documentation in the works! Stay tuned for exciting updates as we keep improving and expanding the app.</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,4 @@ | ||
| --- | ||
| layout: md | ||
| title: "Get Started" | ||
| layout: redirect | ||
| target: "/pages/documentation/general-install" | ||
| --- | ||
|
|
||
| # Get Started with _RestApia_ | ||
|
|
||
| Welcome to _RestApia_! This guide will walk you through the steps to install and start using the app right away. | ||
|
|
||
| ## Installation | ||
|
|
||
| RestApia is available for installation via the [Windows Package Manager (winget)](https://aka.ms/winget). To get started, simply open a terminal and use the following command: | ||
|
|
||
| ```bash | ||
| winget install RestApia | ||
| ``` | ||
|
|
||
| This will automatically download and install RestApia on your machine. After the installation is complete, you can launch the application from your desktop or terminal. | ||
|
|
||
| ### Step-by-Step Installation: | ||
|
|
||
| 1. **Open Command Prompt or Terminal** | ||
| - Press `Win + R`, type `cmd`, and press Enter to open Command Prompt. | ||
| - Alternatively, search for **Terminal** in your Start menu. | ||
|
|
||
| 2. **Run the Install Command** | ||
| - In your terminal, type the install command provided earlier and hit Enter. | ||
|
|
||
| 3. **Wait for Installation to Complete** | ||
| - The installation process will take a few moments. Once completed, RestApia will be installed and ready to use. | ||
|
|
||
| 4. **Launch RestApia** | ||
| - After the installation completes, **RestApia** will launch automatically. You can also find it later in your Start menu or use the desktop icon that has been added. | ||
|
|
||
| ## First-Time Setup | ||
|
|
||
| Once you have RestApia installed, you can dive straight into creating and managing API requests. No additional setup is required—just open the app and start building your first project. | ||
|
|
||
| ## Need Help? | ||
|
|
||
| - If you encounter any issues or have questions about setting up, feel free to check our [Documentation](/pages/docs) or join our [Discord Community](https://discord.gg/FZuQyEpYM4). | ||
| - [Looking for other platform?](/pages/docs/cross-platform) | ||
|
|
||
| --- | ||
|
|
||
| With just a few steps, you’re ready to start exploring the power of RestApia. Happy testing! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,4 @@ | ||
| --- | ||
| layout: md | ||
| title: "Support" | ||
| layout: redirect | ||
| target: "/pages/support/support-introduction" | ||
| --- | ||
|
|
||
| # Support | ||
|
|
||
| We’re here to help! Whether you’ve encountered a bug, have a feature request, or just need assistance, **RestApia** offers several ways to get support. | ||
|
|
||
| ## Reporting Bugs and Feature Requests | ||
|
|
||
| All users can easily report bugs or send us feature requests via GitHub. We encourage you to visit our [GitHub Issues page](https://github.com/RestApia/RestApia.Community/issues) where you can: | ||
|
|
||
| - **Report a Bug**: Found an issue? Let us know by submitting a bug report. Check out our [How to Report a Bug](/pages/docs/how-to-report-bug) guide for step-by-step instructions. | ||
| - **Submit a Feature Request**: Have a great idea to make RestApia even better? Share it with us! Visit the [Sending Feature Requests](/pages/docs/how-to-request-feature) page to learn how to submit your ideas. | ||
|
|
||
| ## Additional Support for Team and Enterprise Plans | ||
|
|
||
| Users on the **Team** and **Enterprise** plans receive additional attention to their requests. This includes higher priority for feature requests and direct communication channels for a more responsive support experience. | ||
|
|
||
| For more information on upgrading to a Team or Enterprise plan, check out our [Pricing page](/pages/pricing). | ||
|
|
||
| --- | ||
|
|
||
| We’re always here to help, and your feedback is invaluable in improving **RestApia** for everyone. Join our community on [Discord](https://discord.gg/FZuQyEpYM4) to stay up-to-date and connect with other users. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| <ul> | ||
| <li>Support</li> | ||
| <li><a href="/pages/support/support-introduction">Introduction</a></li> | ||
| </ul> | ||
|
|
||
| <ul> | ||
| <li>Legal</li> | ||
| <li><a href="/pages/support/legal-license">End-User License Agreement</a></li> | ||
| <li><a href="/pages/support/legal-privacy-policy">Privacy Policy</a></li> | ||
| </ul> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <h1> | ||
| <i class="ph ph-barricade fg-warning"></i> | ||
| Page Coming Soon | ||
| </h1> | ||
|
|
||
| Thank you for your interest in this section of **RestApia**. This page is still under construction as we work to bring you more features and content. | ||
|
|
||
| --- | ||
|
|
||
| We’re constantly improving and expanding **RestApia** to offer the best experience possible. Check back soon for updates! | ||
|
|
||
| In the meantime, feel free to explore the rest of our [Documentation](/pages/extensions/general-introduction), join the discussion on our [Discord Community](https://discord.gg/FZuQyEpYM4), or visit our [GitHub Issues page](https://github.com/RestApia/RestApia.Community/issues) to submit feature requests and bug reports. | ||
|
|
||
| We appreciate your patience and are excited to share what's coming next! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| layout: documentation | ||
| title: "RestApia License" | ||
| --- | ||
|
|
||
| # RestApia End-User License Agreement | ||
|
|
||
| ## 1. License Scope and Usage Restrictions | ||
|
|
||
| - **Free Plan (Personal Use Only)**: The Free Plan is strictly for individual, non-commercial projects. Usage within any commercial organization or for profit-driven projects is prohibited. However, educational institutions are permitted to use the Free Plan for teaching and training purposes within their organizations, provided that such use is non-commercial (e.g., not used in paid educational programs). | ||
|
|
||
| - **Team Plan**: Provides access to RestApia for commercial use within smaller teams, with limitations on certain features compared to the Enterprise Plan (e.g., limited access to advanced analytics and integrations). For detailed features and pricing, see the RestApia [Pricing Page](/pages/pricing). | ||
|
|
||
| - **Enterprise Plan**: Designed for larger organizations, the Enterprise Plan includes access to all standard features of RestApia. Some future cloud services may be provided at an additional cost. For detailed features and pricing, see the RestApia [Pricing Page](/pages/pricing). | ||
|
|
||
| - **Exceptional Access**: RestApia reserves the right to issue time-limited or perpetual licenses to specific clients at its discretion, under terms mutually agreed upon with those clients. | ||
|
|
||
| ## 2. Liability and Warranty Disclaimer | ||
|
|
||
| RestApia is provided "as-is," without warranties of any kind, express or implied. The RestApia is not liable for any damages, including hardware or software issues, data loss, security breaches, or business interruptions, arising from the use or inability to use RestApia. Users assume full responsibility for their use of the application. | ||
|
|
||
| ## 3. Third-Party Extensions | ||
|
|
||
| RestApia supports extensions developed by third-party developers. However, RestApia cannot guarantee compatibility, security, or functionality of any third-party extension. Users acknowledge that RestApia is not liable for any issues or damages resulting from the use of these extensions. | ||
|
|
||
| ## 4. Termination | ||
|
|
||
| RestApia reserves the right to terminate or restrict access to the application at its discretion, for any reason it deems necessary, including but not limited to unauthorized commercial use of the Free Plan or attempts to modify or reverse-engineer the software. Users will generally be given notice prior to termination, except in cases of severe violations. | ||
|
|
||
| ## 5. Data Privacy | ||
|
|
||
| RestApia may collect anonymous usage data, including application statistics, to improve product functionality. Users can disable data collection within the application settings if they choose. | ||
|
|
||
| ## 6. Reverse Engineering and Modification | ||
|
|
||
| Users are prohibited from decompiling, reverse-engineering, or modifying RestApia without explicit permission from the RestApia, except in cases where such actions are approved for integration or development purposes. | ||
|
|
||
| ## 7. Jurisdiction and Governing Law | ||
|
|
||
| This agreement is governed by the laws of Switzerland. Any disputes arising from this agreement shall be resolved in the courts of Switzerland. | ||
|
|
||
| ## 8. Amendments | ||
|
|
||
| RestApia reserves the right to modify this license agreement at any time. Users will be notified of any material changes within the application at least 30 days prior to the changes taking effect. Continued use of RestApia after such changes implies acceptance of the revised terms. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| layout: documentation | ||
| title: "Privacy Policy" | ||
| updateDate: "2024-10-08" | ||
| --- | ||
|
|
||
| # Privacy Policy for RestApia Desktop Application | ||
|
|
||
| ## Introduction | ||
|
|
||
| RestApia ("we," "our," or "us") respects your privacy and is committed to protecting your personal data. This privacy policy applies specifically to the RestApia desktop application and will inform you about how we handle your personal data. Separate privacy policies apply to our web portal and other services. | ||
|
|
||
| ## 1. Important Information and Who We Are | ||
|
|
||
| **Controller**: RestApia is the controller and is responsible for your personal data when you use the desktop application. | ||
|
|
||
| **Contact Details**: If you have any questions about this privacy policy or our privacy practices, please contact us at: | ||
|
|
||
| **Email:** [email protected] (for privacy concerns and support inquiries) | ||
|
|
||
| ## 2. The Data We Collect About You | ||
|
|
||
| **No Data Collection**. RestApia Desktop does not collect any personal data from its users. We do not collect, store, or process any information that could be used to identify you. RestApia collects anonymous telemetry and usage data by default to improve the user experience. Users can disable this feature at any time in the application settings. | ||
|
|
||
| ## 3. How We Use Your Personal Data | ||
|
|
||
| Since RestApia Desktop does not collect any personal data, we do not use any personal data. | ||
|
|
||
| ## 4. Disclosures of Your Personal Data | ||
|
|
||
| **No Data Sharing**. RestApia Desktop does not share any personal data with third parties because we do not collect any personal data. | ||
|
|
||
| ## 5. Data Security | ||
|
|
||
| **No Data Storage**. RestApia Desktop does not store any personal data. As a result, we do not have any data to secure. | ||
|
|
||
| ## 6. Your Legal Rights | ||
|
|
||
| **No Data Collection**. Since we do not collect any personal data, there are no data subject rights applicable to our users under data protection laws. If in the future any data collection takes place, you will be informed and afforded appropriate rights in line with applicable data protection laws. | ||
|
|
||
| ## 7. Changes to This Privacy Policy | ||
|
|
||
| We keep our privacy policy under regular review. This version was last updated on {{ page.updateDate }}. Any changes to this privacy policy will be posted on our website: [https://restapia.app/pages/legal/privacy-policy](https://restapia.app/pages/legal/privacy-policy). We may also notify you of changes through the application itself when such updates are significant. | ||
|
|
||
| ## 8. Compliance with Laws | ||
|
|
||
| RestApia complies with relevant data protection laws and regulations. While we do not collect personal data, RestApia ensures compliance with global data protection frameworks such as GDPR and CCPA, to the extent applicable. Since we do not collect any personal data, most provisions of these laws do not apply to us. | ||
|
|
||
| ## 9. Legal Clarity | ||
|
|
||
| This privacy policy is governed by the laws of Switzerland. | ||
|
|
||
| ## 10. Contact Information | ||
|
|
||
| If you have any questions or concerns about this privacy policy, please contact us at <[email protected]>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| layout: documentation | ||
| title: "Support" | ||
| --- | ||
|
|
||
| # Support | ||
|
|
||
| We’re here to help! Whether you’ve encountered a bug, have a feature request, or just need assistance, _RestApia_ offers several ways to get support. | ||
|
|
||
| ## Reporting Bugs and Feature Requests | ||
|
|
||
| All users can easily report bugs or send us feature requests via GitHub. We encourage you to visit our [GitHub Issues page](https://github.com/RestApia/RestApia.Community/issues) where you can: | ||
|
|
||
| - **Report a Bug**: Found an issue? Let us know by submitting a bug report. Check out our [How to Report a Bug](/pages/docs/how-to-report-bug) guide for step-by-step instructions. | ||
| - **Submit a Feature Request**: Have a great idea to make RestApia even better? Share it with us! Visit the [Sending Feature Requests](/pages/docs/how-to-request-feature) page to learn how to submit your ideas. | ||
|
|
||
| ## Additional Support for Team and Enterprise Plans | ||
|
|
||
| Users on the **Team** and **Enterprise** plans receive additional attention to their requests. This includes higher priority for feature requests and direct communication channels for a more responsive support experience. | ||
|
|
||
| For more information on upgrading to a Team or Enterprise plan, check out our [Pricing page](/pages/pricing). | ||
|
|
||
| --- | ||
|
|
||
| We’re always here to help, and your feedback is invaluable in improving **RestApia** for everyone. Join our community on [Discord](https://discord.gg/FZuQyEpYM4) to stay up-to-date and connect with other users. |
Oops, something went wrong.