Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: proxy component #1444

Merged
merged 44 commits into from
Jan 7, 2025
Merged
Changes from 1 commit
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
0ecabba
feat: add proxy tab changes
hetangmodi-crest Oct 14, 2024
21ed369
feat: added `need-proxy` in init function
hetangmodi-crest Nov 11, 2024
e8ce59b
tests(unit): updated test case for init method
hetangmodi-crest Nov 11, 2024
27ebf4b
docs: updated the docs for `--need-proxy` argument
hetangmodi-crest Nov 11, 2024
2bea8f8
feat: added proxy component
hetangmodi-crest Nov 11, 2024
273a7ed
tests: added test cases for proxy component
hetangmodi-crest Nov 11, 2024
699f99c
feat: updated the fetching of proxy
hetangmodi-crest Nov 11, 2024
c002258
tests(smoke): updated the test cases
hetangmodi-crest Nov 11, 2024
ceb3182
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Nov 12, 2024
686a744
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Nov 13, 2024
395a562
docs: updated documentation regarding proxy tab
hetangmodi-crest Nov 13, 2024
5eb8e36
ci: fixed pre-commit failures
hetangmodi-crest Nov 13, 2024
ef6eea6
tests: updated unit test case
hetangmodi-crest Nov 13, 2024
f907e61
tests(smoke): added proxyTab in global_config_update
hetangmodi-crest Nov 13, 2024
26bf7fa
fix: fix for UI test cases
hetangmodi-crest Nov 14, 2024
607ab26
fix: skips the migration on proxy tab
hetangmodi-crest Nov 14, 2024
95c680d
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Nov 15, 2024
81a9a7d
chore: changed label of DNS resolution
hetangmodi-crest Nov 15, 2024
e89efa4
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Nov 18, 2024
d85c82a
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Nov 19, 2024
465f71c
fix: pre-commit fix in docs
hetangmodi-crest Nov 19, 2024
310f7a4
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Nov 21, 2024
0b6d30e
docs: simplified the documentation
hetangmodi-crest Nov 21, 2024
8956d97
feat: checks `sonlib` version if oauth is present
hetangmodi-crest Nov 21, 2024
134ca45
tests(unit): add unit test case
hetangmodi-crest Nov 21, 2024
02f0e9c
chore: merge branch 'develop' into feat/proxy-component
hetangmodi-crest Nov 26, 2024
d769db8
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Nov 27, 2024
62fc83e
chore: update log statements
hetangmodi-crest Nov 28, 2024
3a5708b
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Nov 28, 2024
219bf5e
Merge branch 'develop' into feat/proxy-component
artemrys Nov 28, 2024
a2d9c80
chore: update templates and schema.json
hetangmodi-crest Nov 29, 2024
5aedea1
fix: update schema.json
hetangmodi-crest Dec 2, 2024
7056156
chore: merge branch 'develop' into feat/proxy-component
hetangmodi-crest Dec 3, 2024
a8aabd6
chore: resolve code review comments
hetangmodi-crest Dec 3, 2024
0758319
test(unit): update unit test case after rebasing
hetangmodi-crest Dec 3, 2024
10a778e
fix: remove restHandlers from schema for proxy
hetangmodi-crest Dec 10, 2024
b703f03
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Dec 10, 2024
2d6ac73
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Dec 12, 2024
d2bfe29
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Dec 13, 2024
cb55b05
docs: update proxy documentation
hetangmodi-crest Dec 13, 2024
e230928
Merge branch 'develop' into feat/proxy-component
hetangmodi-crest Dec 16, 2024
ad2c7c3
docs: update the proxy doc
hetangmodi-crest Dec 18, 2024
74940e2
chore: merge branch 'develop' into feat/proxy-component
hetangmodi-crest Jan 6, 2025
ac16833
chore: update license header
hetangmodi-crest Jan 6, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: simplified the documentation
hetangmodi-crest committed Nov 21, 2024

Verified

This commit was signed with the committer’s verified signature.
hetangmodi-crest Hetang Modi
commit 0b6d30ebaa33cf587ba8b571e7a3fe7a3e050c36
4 changes: 2 additions & 2 deletions docs/configurations/index.md
Original file line number Diff line number Diff line change
@@ -75,7 +75,7 @@ Currently available tab components:
}
```

Note: The example above creates a Configuration page with two **empty** tabs: Account and Proxy.
Note: The example above creates a Configuration page with an **empty** Account tab.
Specify your properties in `"table"` and `"entity"`.

### Output
@@ -84,7 +84,7 @@ This is how table looks in the UI:

![image](../images/configuration/configuration_with_table_output.png)

This is how form looks in the UI:
This is how Proxy tab looks in the UI:

![image](../images/configuration/proxy_tab_with_warning.png)

6 changes: 3 additions & 3 deletions docs/configurations/proxy.md
Original file line number Diff line number Diff line change
@@ -142,7 +142,7 @@ Proxy
}
```

If you only specify `"type": "proxyTab"` in your globalConfig file, entities such as `proxy_type`, `username`, `password`, and `dns_resolution` will not be generated, only the `host`, `port`, `enabled` entities will be generated. To include the optional entities in your add-on (from the [available configurations](#available-configurations) listed above), you need to set them to `True`.
If you only specify `"type": "proxyTab"` in your globalConfig file, then entities such as `proxy_type`, `username`, `password`, and `dns_resolution` will not be generated, only `host`, `port`, `enabled` entities will be generated. To include the optional entities in your add-on (refer [available configurations](#available-configurations) listed above), you need to set them to `True`.

### Usage

@@ -164,7 +164,7 @@ It is placed just like every other configuration tab.
}
```

To customize these entities, you can define them in JSON with specific keys for each one (see the [keys section](#keys) for details on the required keys for each entity). You only need to specify your custom values in the JSON there's no need to include required fields like `type`, `fields` (if you don't need to change them) etc. Refer to the [Example](#example) for further clarification.
TTo customize these entities, you can define them in JSON format by specifying certain keys unique to each entity (refer the [keys section](#keys) for details on the required keys for each entity). When creating the JSON, you only need to include the values you want to customize. For example, if you don’t need to modify fields like `lable` or `field`, you can skip including them in your globalConfig. For better understanding, refer to the provided [Example](#example) which demonstrates how to apply customizations effectively.

> **_NOTE:_**
There are 2 ways to exclude optional entities in your add-on, either omit them from the proxy tab, or set the entities to false.
@@ -220,6 +220,6 @@ The above will get converted to the older definition (mentioned below) in your o

```json
{
--8<-- "tests/unit/tabs/test_proxy_tab.py:9:71"
--8<-- "tests/unit/tabs/test_proxy_tab.py:9:69"
}
```