Compare commits

...

13 Commits

Author SHA1 Message Date
ffc27f2494 changing css and template to better visualize sidebar
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-02-23 11:56:31 +00:00
ec7ca5950f Update workflow picture and description
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2023-02-23 09:09:36 +00:00
7e9fac0fb1 Context - Whom to address for Feedback?
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@telekom.de>
Co-committed-by: Gode, Sebastian <sebastian.gode@telekom.de>
2023-02-23 08:45:36 +00:00
22e3c2a594 fixing the figure
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-02-23 08:20:32 +00:00
c90518331b Gitea Account creation tutorial
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@telekom.de>
Co-committed-by: Gode, Sebastian <sebastian.gode@telekom.de>
2023-02-23 00:56:00 +00:00
7da187b6f0 updated introduction content
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-02-22 08:58:39 +00:00
5a2b5b5407 add content structure of Helpcenter 3.0 training
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2023-02-21 09:56:16 +00:00
ed2dcd9e1a adding new content and syncing with prod portal
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-01-24 09:30:14 +00:00
b0ebf6a663 update for tox v4
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2023-01-18 17:37:34 +00:00
ddc15bd2b1 Switch to helpcenter-base-jobs zuul template
Reviewed-by: Goncharov, Artem <artem.goncharov@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-11-16 14:54:31 +00:00
883754be2b Trigger portal rebuild
Reviewed-by: Goncharov, Artem <artem.goncharov@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-11-09 16:53:05 +00:00
749062233d disable smartquotes
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-11-03 10:57:36 +00:00
13801dc1bd Rework metadata
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-08-24 08:59:38 +00:00
107 changed files with 4305 additions and 405 deletions

3
.gitignore vendored
View File

@ -14,6 +14,9 @@ api-ref/build
*.log *.log
*.egg* *.egg*
# Bytecompiled Python
*.py[cod]
# Editors # Editors
*~ *~

View File

@ -10,3 +10,5 @@
sphinx>=4.0.0 sphinx>=4.0.0
otcdocstheme otcdocstheme
reno>=3.1.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
# commit 7cbdf09617f6d0ac5450ab1b9e3f3ae68fc55c0e
git+https://git@gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git

File diff suppressed because it is too large Load Diff

View File

@ -47,3 +47,12 @@
.navigator-container .card li { .navigator-container .card li {
padding: 0.2rem 1rem; padding: 0.2rem 1rem;
} }
/* A "nice" workaround to let us keep l2 level permanently open
* but hide child ul's not underneath current selection.
* The only eventually open issue is that this way the whole child tree is
* open including all subtrees.
*/
.docs-sidebar-toc li.toctree-l2:not(.current) > ul {
display: none;
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 186 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

View File

@ -0,0 +1 @@
<svg width="48" height="52" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" overflow="hidden"><defs><clipPath id="clip0"><rect x="675" y="337" width="48" height="52"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-675 -337)"><path d="M719.373 346.852C717.037 345.983 712.075 344.534 709.739 343.375 704.776 340.767 702.733 339.028 700.981 337.869 700.398 337.29 699.522 337 698.646 337 698.646 337 698.646 337 698.646 337 698.646 337 698.646 337 698.646 337 697.77 337 696.894 337.29 696.019 337.869 694.267 339.028 692.516 340.767 687.553 343.375 684.925 344.534 680.255 345.983 677.627 346.852 676.168 347.432 675 348.881 675.292 350.619 675.584 355.545 677.043 365.977 680.255 372.352 683.758 379.597 693.099 385.392 696.602 387.42 697.186 388 698.062 388 698.646 388 699.23 388 699.814 388 700.398 387.42 704.193 385.392 713.242 379.597 717.037 372.352 720.248 365.977 721.416 355.545 722 350.619 722 348.881 721.124 347.432 719.373 346.852ZM714.994 371.193C712.658 375.83 707.404 380.756 699.23 385.392 698.938 385.682 698.646 385.682 698.646 385.682 698.354 385.682 698.062 385.682 698.062 385.392 689.888 380.756 684.634 375.83 682.298 371.193 679.087 364.818 677.919 353.517 677.627 350.33 677.627 349.46 678.211 349.17 678.503 349.17 679.379 348.881 679.379 348.881 679.379 348.881 682.006 347.722 686.093 346.562 688.429 345.403 693.099 343.085 695.143 341.347 696.894 340.188 697.186 339.898 697.186 339.898 697.478 339.608 697.77 339.608 698.062 339.318 698.354 339.318 698.354 339.318 698.354 339.318 698.354 339.318 698.646 339.318 698.646 339.318 698.646 339.318 698.646 339.318 698.646 339.318 698.646 339.318 699.23 339.318 699.522 339.608 699.522 339.608 699.814 339.898 700.106 339.898 700.398 340.188 702.149 341.347 704.193 343.085 708.571 345.403 710.907 346.562 714.994 347.722 717.913 348.881 718.789 349.17 718.789 349.17 718.789 349.17 718.789 349.17 719.665 349.46 719.665 350.33 719.373 353.517 718.205 364.818 714.994 371.193ZM691.64 365.688C691.64 369.455 694.851 372.642 698.646 372.642 702.441 372.642 705.36 369.455 705.36 365.688 705.36 361.92 698.646 356.125 698.646 349.75 698.646 356.125 691.64 361.92 691.64 365.688ZM701.857 360.472C703.025 362.5 704.484 364.528 704.484 365.688 704.484 368.875 701.857 371.483 698.646 371.483 695.435 371.483 692.807 368.875 692.807 365.688 692.807 364.528 693.975 362.5 695.435 360.472 696.602 358.733 697.77 356.705 698.646 354.676 699.522 356.705 700.689 358.443 701.857 360.472Z" fill="#484848" fill-rule="evenodd"/></g></svg>

After

Width:  |  Height:  |  Size: 2.5 KiB

View File

@ -0,0 +1 @@
<svg width="51" height="50" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" overflow="hidden"><defs><clipPath id="clip0"><rect x="277" y="152" width="51" height="50"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-277 -152)"><path d="M324.216 177.469C315.585 172.486 315.585 172.486 315.585 172.486 315.585 161.966 315.585 161.966 315.585 161.966 315.585 160.305 314.193 158.09 312.523 156.983 305.562 153.107 305.562 153.107 305.562 153.107 303.892 152 301.386 152 299.716 153.107 292.477 156.983 292.477 156.983 292.477 156.983 290.807 158.09 289.693 160.305 289.693 161.966 289.693 172.486 289.693 172.486 289.693 172.486 281.062 177.469 281.062 177.469 281.062 177.469 279.392 178.576 278 180.791 278 182.452 278 191.311 278 191.311 278 191.311 278 193.249 279.392 195.186 281.062 196.294 288.023 200.446 288.023 200.446 288.023 200.446 288.858 200.723 289.972 201 291.085 201 291.92 201 293.034 200.723 293.869 200.446 302.5 195.463 302.5 195.463 302.5 195.463 311.409 200.446 311.409 200.446 311.409 200.446 312.244 200.723 313.08 201 314.193 201 315.307 201 316.142 200.723 316.977 200.446 324.216 196.294 324.216 196.294 324.216 196.294 325.886 195.463 327 193.249 327 191.311 327 182.452 327 182.452 327 182.452 327 180.791 325.886 178.576 324.216 177.469ZM302.5 193.802C302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802ZM293.869 159.198C300.83 155.322 300.83 155.322 300.83 155.322 301.665 154.768 303.335 154.768 304.17 155.322 311.409 159.198 311.409 159.198 311.409 159.198 312.244 159.751 312.801 161.136 312.801 161.966 312.801 173.316 312.801 173.316 312.801 173.316 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 303.892 177.746 303.335 177.192 302.5 177.192 301.943 177.192 301.108 177.746 300.83 178.023 300.83 178.023 300.83 178.023 300.83 178.023 300.551 178.023 300.551 178.023 300.551 178.023 292.199 173.316 292.199 173.316 292.199 173.316 292.199 161.966 292.199 161.966 292.199 161.966 292.199 161.136 293.034 159.751 293.869 159.198ZM292.477 197.955C291.642 198.508 290.25 198.508 289.415 197.955 282.176 194.079 282.176 194.079 282.176 194.079 281.341 193.525 280.784 192.141 280.784 191.311 280.784 182.452 280.784 182.452 280.784 182.452 280.784 181.621 281.341 180.237 282.176 179.684 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.407 299.994 179.684 299.994 179.96 299.994 181.068 300.83 182.175 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 192.695 301.943 192.695 301.943 192.695L292.477 197.955ZM324.494 191.311C324.494 192.141 323.659 193.525 322.824 194.079 315.864 198.232 315.864 198.232 315.864 198.232 315.028 198.508 313.358 198.508 312.523 198.232 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 304.449 182.175 305.006 181.068 305.006 179.96 305.006 179.684 305.006 179.407 305.006 179.13 305.006 179.13 305.006 179.13 305.006 179.13 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 322.824 179.96 322.824 179.96 322.824 179.96 323.659 180.237 324.494 181.621 324.494 182.452L324.494 191.311Z" fill="#484848" fill-rule="evenodd"/></g></svg>

After

Width:  |  Height:  |  Size: 3.5 KiB

View File

@ -0,0 +1 @@
<svg width="51" height="50" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" overflow="hidden"><defs><clipPath id="clip0"><rect x="277" y="152" width="51" height="50"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-277 -152)"><path d="M324.216 177.469C315.585 172.486 315.585 172.486 315.585 172.486 315.585 161.966 315.585 161.966 315.585 161.966 315.585 160.305 314.193 158.09 312.523 156.983 305.562 153.107 305.562 153.107 305.562 153.107 303.892 152 301.386 152 299.716 153.107 292.477 156.983 292.477 156.983 292.477 156.983 290.807 158.09 289.693 160.305 289.693 161.966 289.693 172.486 289.693 172.486 289.693 172.486 281.062 177.469 281.062 177.469 281.062 177.469 279.392 178.576 278 180.791 278 182.452 278 191.311 278 191.311 278 191.311 278 193.249 279.392 195.186 281.062 196.294 288.023 200.446 288.023 200.446 288.023 200.446 288.858 200.723 289.972 201 291.085 201 291.92 201 293.034 200.723 293.869 200.446 302.5 195.463 302.5 195.463 302.5 195.463 311.409 200.446 311.409 200.446 311.409 200.446 312.244 200.723 313.08 201 314.193 201 315.307 201 316.142 200.723 316.977 200.446 324.216 196.294 324.216 196.294 324.216 196.294 325.886 195.463 327 193.249 327 191.311 327 182.452 327 182.452 327 182.452 327 180.791 325.886 178.576 324.216 177.469ZM302.5 193.802C302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802ZM293.869 159.198C300.83 155.322 300.83 155.322 300.83 155.322 301.665 154.768 303.335 154.768 304.17 155.322 311.409 159.198 311.409 159.198 311.409 159.198 312.244 159.751 312.801 161.136 312.801 161.966 312.801 173.316 312.801 173.316 312.801 173.316 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 303.892 177.746 303.335 177.192 302.5 177.192 301.943 177.192 301.108 177.746 300.83 178.023 300.83 178.023 300.83 178.023 300.83 178.023 300.551 178.023 300.551 178.023 300.551 178.023 292.199 173.316 292.199 173.316 292.199 173.316 292.199 161.966 292.199 161.966 292.199 161.966 292.199 161.136 293.034 159.751 293.869 159.198ZM292.477 197.955C291.642 198.508 290.25 198.508 289.415 197.955 282.176 194.079 282.176 194.079 282.176 194.079 281.341 193.525 280.784 192.141 280.784 191.311 280.784 182.452 280.784 182.452 280.784 182.452 280.784 181.621 281.341 180.237 282.176 179.684 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.407 299.994 179.684 299.994 179.96 299.994 181.068 300.83 182.175 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 192.695 301.943 192.695 301.943 192.695L292.477 197.955ZM324.494 191.311C324.494 192.141 323.659 193.525 322.824 194.079 315.864 198.232 315.864 198.232 315.864 198.232 315.028 198.508 313.358 198.508 312.523 198.232 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 304.449 182.175 305.006 181.068 305.006 179.96 305.006 179.684 305.006 179.407 305.006 179.13 305.006 179.13 305.006 179.13 305.006 179.13 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 322.824 179.96 322.824 179.96 322.824 179.96 323.659 180.237 324.494 181.621 324.494 182.452L324.494 191.311Z" fill="#484848" fill-rule="evenodd"/></g></svg>

After

Width:  |  Height:  |  Size: 3.5 KiB

View File

@ -0,0 +1 @@
<svg width="51" height="50" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" overflow="hidden"><defs><clipPath id="clip0"><rect x="277" y="152" width="51" height="50"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-277 -152)"><path d="M324.216 177.469C315.585 172.486 315.585 172.486 315.585 172.486 315.585 161.966 315.585 161.966 315.585 161.966 315.585 160.305 314.193 158.09 312.523 156.983 305.562 153.107 305.562 153.107 305.562 153.107 303.892 152 301.386 152 299.716 153.107 292.477 156.983 292.477 156.983 292.477 156.983 290.807 158.09 289.693 160.305 289.693 161.966 289.693 172.486 289.693 172.486 289.693 172.486 281.062 177.469 281.062 177.469 281.062 177.469 279.392 178.576 278 180.791 278 182.452 278 191.311 278 191.311 278 191.311 278 193.249 279.392 195.186 281.062 196.294 288.023 200.446 288.023 200.446 288.023 200.446 288.858 200.723 289.972 201 291.085 201 291.92 201 293.034 200.723 293.869 200.446 302.5 195.463 302.5 195.463 302.5 195.463 311.409 200.446 311.409 200.446 311.409 200.446 312.244 200.723 313.08 201 314.193 201 315.307 201 316.142 200.723 316.977 200.446 324.216 196.294 324.216 196.294 324.216 196.294 325.886 195.463 327 193.249 327 191.311 327 182.452 327 182.452 327 182.452 327 180.791 325.886 178.576 324.216 177.469ZM302.5 193.802C302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802ZM293.869 159.198C300.83 155.322 300.83 155.322 300.83 155.322 301.665 154.768 303.335 154.768 304.17 155.322 311.409 159.198 311.409 159.198 311.409 159.198 312.244 159.751 312.801 161.136 312.801 161.966 312.801 173.316 312.801 173.316 312.801 173.316 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 303.892 177.746 303.335 177.192 302.5 177.192 301.943 177.192 301.108 177.746 300.83 178.023 300.83 178.023 300.83 178.023 300.83 178.023 300.551 178.023 300.551 178.023 300.551 178.023 292.199 173.316 292.199 173.316 292.199 173.316 292.199 161.966 292.199 161.966 292.199 161.966 292.199 161.136 293.034 159.751 293.869 159.198ZM292.477 197.955C291.642 198.508 290.25 198.508 289.415 197.955 282.176 194.079 282.176 194.079 282.176 194.079 281.341 193.525 280.784 192.141 280.784 191.311 280.784 182.452 280.784 182.452 280.784 182.452 280.784 181.621 281.341 180.237 282.176 179.684 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.407 299.994 179.684 299.994 179.96 299.994 181.068 300.83 182.175 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 192.695 301.943 192.695 301.943 192.695L292.477 197.955ZM324.494 191.311C324.494 192.141 323.659 193.525 322.824 194.079 315.864 198.232 315.864 198.232 315.864 198.232 315.028 198.508 313.358 198.508 312.523 198.232 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 304.449 182.175 305.006 181.068 305.006 179.96 305.006 179.684 305.006 179.407 305.006 179.13 305.006 179.13 305.006 179.13 305.006 179.13 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 322.824 179.96 322.824 179.96 322.824 179.96 323.659 180.237 324.494 181.621 324.494 182.452L324.494 191.311Z" fill="#484848" fill-rule="evenodd"/></g></svg>

After

Width:  |  Height:  |  Size: 3.5 KiB

View File

@ -0,0 +1 @@
<svg width="51" height="50" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" overflow="hidden"><defs><clipPath id="clip0"><rect x="277" y="152" width="51" height="50"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-277 -152)"><path d="M324.216 177.469C315.585 172.486 315.585 172.486 315.585 172.486 315.585 161.966 315.585 161.966 315.585 161.966 315.585 160.305 314.193 158.09 312.523 156.983 305.562 153.107 305.562 153.107 305.562 153.107 303.892 152 301.386 152 299.716 153.107 292.477 156.983 292.477 156.983 292.477 156.983 290.807 158.09 289.693 160.305 289.693 161.966 289.693 172.486 289.693 172.486 289.693 172.486 281.062 177.469 281.062 177.469 281.062 177.469 279.392 178.576 278 180.791 278 182.452 278 191.311 278 191.311 278 191.311 278 193.249 279.392 195.186 281.062 196.294 288.023 200.446 288.023 200.446 288.023 200.446 288.858 200.723 289.972 201 291.085 201 291.92 201 293.034 200.723 293.869 200.446 302.5 195.463 302.5 195.463 302.5 195.463 311.409 200.446 311.409 200.446 311.409 200.446 312.244 200.723 313.08 201 314.193 201 315.307 201 316.142 200.723 316.977 200.446 324.216 196.294 324.216 196.294 324.216 196.294 325.886 195.463 327 193.249 327 191.311 327 182.452 327 182.452 327 182.452 327 180.791 325.886 178.576 324.216 177.469ZM302.5 193.802C302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802ZM293.869 159.198C300.83 155.322 300.83 155.322 300.83 155.322 301.665 154.768 303.335 154.768 304.17 155.322 311.409 159.198 311.409 159.198 311.409 159.198 312.244 159.751 312.801 161.136 312.801 161.966 312.801 173.316 312.801 173.316 312.801 173.316 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 303.892 177.746 303.335 177.192 302.5 177.192 301.943 177.192 301.108 177.746 300.83 178.023 300.83 178.023 300.83 178.023 300.83 178.023 300.551 178.023 300.551 178.023 300.551 178.023 292.199 173.316 292.199 173.316 292.199 173.316 292.199 161.966 292.199 161.966 292.199 161.966 292.199 161.136 293.034 159.751 293.869 159.198ZM292.477 197.955C291.642 198.508 290.25 198.508 289.415 197.955 282.176 194.079 282.176 194.079 282.176 194.079 281.341 193.525 280.784 192.141 280.784 191.311 280.784 182.452 280.784 182.452 280.784 182.452 280.784 181.621 281.341 180.237 282.176 179.684 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.407 299.994 179.684 299.994 179.96 299.994 181.068 300.83 182.175 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 192.695 301.943 192.695 301.943 192.695L292.477 197.955ZM324.494 191.311C324.494 192.141 323.659 193.525 322.824 194.079 315.864 198.232 315.864 198.232 315.864 198.232 315.028 198.508 313.358 198.508 312.523 198.232 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 304.449 182.175 305.006 181.068 305.006 179.96 305.006 179.684 305.006 179.407 305.006 179.13 305.006 179.13 305.006 179.13 305.006 179.13 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 322.824 179.96 322.824 179.96 322.824 179.96 323.659 180.237 324.494 181.621 324.494 182.452L324.494 191.311Z" fill="#484848" fill-rule="evenodd"/></g></svg>

After

Width:  |  Height:  |  Size: 3.5 KiB

View File

@ -0,0 +1 @@
<svg width="44" height="43" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" overflow="hidden"><defs><clipPath id="clip0"><rect x="1129" y="166" width="44" height="43"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-1129 -166)"><path d="M1158.93 197C1157.07 199 1157.07 199 1157.07 199 1157.07 191.5 1157.07 191.5 1157.07 191.5 1157.07 191.25 1157.07 191 1156.53 191 1156.27 191 1156 191.25 1156 191.5 1156 200.5 1156 200.5 1156 200.5 1156 200.75 1156.27 200.75 1156.53 201 1156.53 201 1156.53 201 1156.53 201 1156.8 201 1157.07 200.75 1157.07 200.75 1159.73 197.75 1159.73 197.75 1159.73 197.75 1160 197.5 1160 197.25 1159.73 197 1159.47 196.75 1159.2 197 1158.93 197Z" fill="#404040" fill-rule="evenodd"/><path d="M1145.5 191C1145.25 191 1145 191.25 1145 191.5 1145 200.5 1145 200.5 1145 200.5 1145 200.75 1145.25 201 1145.5 201 1146 201 1146 200.75 1146 200.5 1146 191.5 1146 191.5 1146 191.5 1146 191.25 1146 191 1145.5 191Z" fill="#404040" fill-rule="evenodd"/><path d="M1159 181.317C1157 181.317 1157 181.317 1157 181.317 1157 174.488 1157 174.488 1157 174.488 1157 174.244 1157 174 1156.5 174 1156.25 174 1156 174.244 1156 174.488 1156 181.317 1156 181.317 1156 181.317 1146 181.317 1146 181.317 1146 181.317 1146 174.488 1146 174.488 1146 174.488 1146 174.244 1146 174 1145.75 174 1145.5 174 1145.25 174 1145.25 174 1142.75 176.927 1142.75 176.927 1142.75 176.927 1142.5 177.171 1142.5 177.659 1142.75 177.659 1143 177.902 1143.25 177.902 1143.5 177.659 1145 175.707 1145 175.707 1145 175.707 1145 181.317 1145 181.317 1145 181.317 1143 181.317 1143 181.317 1143 181.317 1139.25 181.317 1136 184 1136 187.659 1136 191.073 1139.25 194 1143 194 1143.5 194 1143.5 193.756 1143.5 193.512 1143.5 193.268 1143.5 193.024 1143 193.024 1139.75 193.024 1137 190.585 1137 187.659 1137 184.732 1139.75 182.293 1143 182.293 1159 182.293 1159 182.293 1159 182.293 1162.5 182.293 1165 184.732 1165 187.659 1165 190.585 1162.5 193.024 1159 193.024 1158.75 193.024 1158.5 193.268 1158.5 193.512 1158.5 193.756 1158.75 194 1159 194 1163 194 1166 191.073 1166 187.659 1166 184 1163 181.317 1159 181.317Z" fill="#404040" fill-rule="evenodd"/><path d="M1168 166C1134 166 1134 166 1134 166 1132 166 1130 167.75 1130 170 1130 204 1130 204 1130 204 1130 206.25 1132 208 1134 208 1168 208 1168 208 1168 208 1170.25 208 1172 206.25 1172 204 1172 170 1172 170 1172 170 1172 167.75 1170.25 166 1168 166ZM1170 204C1170 205 1169.25 206 1168 206 1134 206 1134 206 1134 206 1133 206 1132 205 1132 204 1132 170 1132 170 1132 170 1132 168.75 1133 168 1134 168 1168 168 1168 168 1168 168 1169.25 168 1170 168.75 1170 170L1170 204Z" fill="#404040" fill-rule="evenodd"/></g></svg>

After

Width:  |  Height:  |  Size: 2.6 KiB

View File

@ -0,0 +1 @@
<svg width="51" height="50" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" overflow="hidden"><defs><clipPath id="clip0"><rect x="277" y="152" width="51" height="50"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-277 -152)"><path d="M324.216 177.469C315.585 172.486 315.585 172.486 315.585 172.486 315.585 161.966 315.585 161.966 315.585 161.966 315.585 160.305 314.193 158.09 312.523 156.983 305.562 153.107 305.562 153.107 305.562 153.107 303.892 152 301.386 152 299.716 153.107 292.477 156.983 292.477 156.983 292.477 156.983 290.807 158.09 289.693 160.305 289.693 161.966 289.693 172.486 289.693 172.486 289.693 172.486 281.062 177.469 281.062 177.469 281.062 177.469 279.392 178.576 278 180.791 278 182.452 278 191.311 278 191.311 278 191.311 278 193.249 279.392 195.186 281.062 196.294 288.023 200.446 288.023 200.446 288.023 200.446 288.858 200.723 289.972 201 291.085 201 291.92 201 293.034 200.723 293.869 200.446 302.5 195.463 302.5 195.463 302.5 195.463 311.409 200.446 311.409 200.446 311.409 200.446 312.244 200.723 313.08 201 314.193 201 315.307 201 316.142 200.723 316.977 200.446 324.216 196.294 324.216 196.294 324.216 196.294 325.886 195.463 327 193.249 327 191.311 327 182.452 327 182.452 327 182.452 327 180.791 325.886 178.576 324.216 177.469ZM302.5 193.802C302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802 302.5 193.802ZM293.869 159.198C300.83 155.322 300.83 155.322 300.83 155.322 301.665 154.768 303.335 154.768 304.17 155.322 311.409 159.198 311.409 159.198 311.409 159.198 312.244 159.751 312.801 161.136 312.801 161.966 312.801 173.316 312.801 173.316 312.801 173.316 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 304.449 178.023 303.892 177.746 303.335 177.192 302.5 177.192 301.943 177.192 301.108 177.746 300.83 178.023 300.83 178.023 300.83 178.023 300.83 178.023 300.551 178.023 300.551 178.023 300.551 178.023 292.199 173.316 292.199 173.316 292.199 173.316 292.199 161.966 292.199 161.966 292.199 161.966 292.199 161.136 293.034 159.751 293.869 159.198ZM292.477 197.955C291.642 198.508 290.25 198.508 289.415 197.955 282.176 194.079 282.176 194.079 282.176 194.079 281.341 193.525 280.784 192.141 280.784 191.311 280.784 182.452 280.784 182.452 280.784 182.452 280.784 181.621 281.341 180.237 282.176 179.684 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 291.642 174.424 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.13 299.994 179.407 299.994 179.684 299.994 179.96 299.994 181.068 300.83 182.175 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 182.452 301.943 192.695 301.943 192.695 301.943 192.695L292.477 197.955ZM324.494 191.311C324.494 192.141 323.659 193.525 322.824 194.079 315.864 198.232 315.864 198.232 315.864 198.232 315.028 198.508 313.358 198.508 312.523 198.232 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 192.695 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 303.335 182.452 304.449 182.175 305.006 181.068 305.006 179.96 305.006 179.684 305.006 179.407 305.006 179.13 305.006 179.13 305.006 179.13 305.006 179.13 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 313.636 174.424 322.824 179.96 322.824 179.96 322.824 179.96 323.659 180.237 324.494 181.621 324.494 182.452L324.494 191.311Z" fill="#484848" fill-rule="evenodd"/></g></svg>

After

Width:  |  Height:  |  Size: 3.5 KiB

View File

@ -0,0 +1 @@
<svg id="rms_1" data-name="rms 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 44 44"><g><path d="M39.5,13.41l-14-8a3,3,0,0,0-3,0l-14,8A3,3,0,0,0,7,16V32a3,3,0,0,0,1.5,2.59l14,8a3,3,0,0,0,3,0l14-8A3,3,0,0,0,41,32V16A3,3,0,0,0,39.5,13.41Zm-1,19.45L25,40.58V28.5a1,1,0,0,0-2,0V40.58L9.5,32.86A1,1,0,0,1,9,32V16.78l10.58,5.85a1,1,0,0,0,1-1.75L9.83,15,23.51,7.13a1,1,0,0,1,1,0L38.22,15l-10.64,5.9a1,1,0,0,0,1,1.75L39,16.84V32A1,1,0,0,1,38.5,32.86Z"></path><path d="M32.5,26a3,3,0,0,0-2.2,1l-5.76-3.4V16.93a3,3,0,1,0-1,0V23.6l-5.68,3.59A3,3,0,1,0,18.5,29a3,3,0,0,0-.16-.94L24,24.46l5.7,3.37A3,3,0,0,0,29.5,29a3,3,0,1,0,3-3Zm-17,5a2,2,0,1,1,2-2A2,2,0,0,1,15.5,31ZM24,16a2,2,0,1,1,2-2A2,2,0,0,1,24,16Zm8.5,15a2,2,0,1,1,2-2A2,2,0,0,1,32.5,31Z"></path></g></svg>

After

Width:  |  Height:  |  Size: 757 B

View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 44 44"><defs><style></style></defs><title>Vpc Endpoint</title><path d="M24,2A22,22,0,1,0,46,24,22,22,0,0,0,24,2Zm0,42A20,20,0,1,1,44,24,20,20,0,0,1,24,44ZM36.5,21A3.42,3.42,0,0,0,33,24H29.5a.5.5,0,0,0-.43.24l-.1.08-5,5V18.5a.5.5,0,0,0-.93-.26l-.1.08L17.32,24l0,0H12.93a2,2,0,1,0,0,1H17.5a.5.5,0,0,0,.43-.24l.1-.08,5-5V30.5a.5.5,0,0,0,.93.26l.1-.08L29.68,25l0,0H33a3.49,3.49,0,1,0,3.45-4Zm0,5.25a1.75,1.75,0,1,1,1.75-1.75A1.76,1.76,0,0,1,36.5,26.25Z" transform="translate(-2 -2)"></path></svg>

After

Width:  |  Height:  |  Size: 546 B

View File

@ -0,0 +1 @@
<svg width="48" height="52" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" overflow="hidden"><defs><clipPath id="clip0"><rect x="151" y="337" width="48" height="52"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-151 -337)"><path d="M187.075 353.807C182.602 353.227 178.429 350.909 176.64 349.17 176.043 348.881 175.745 348.881 175.447 348.881 175.149 348.881 174.553 348.881 174.255 349.17 172.168 350.909 167.994 353.227 163.82 353.807 163.224 354.097 162.627 355.256 162.627 355.835 162.627 356.125 162.925 356.705 162.925 357.284 163.224 360.182 163.522 364.818 166.503 368.585 168.59 371.483 171.87 374.381 174.851 375.83 174.851 375.83 175.149 375.83 175.447 375.83 175.745 375.83 176.043 375.83 176.043 375.83 178.727 374.381 182.006 371.483 184.093 368.585 186.776 365.108 187.373 360.182 187.671 357.284 187.969 356.705 187.969 356.125 187.969 355.835 187.969 355.256 187.671 354.097 187.075 353.807ZM163.82 355.545C163.82 355.545 164.118 355.256 164.118 354.966 166.503 354.676 168.888 353.807 170.975 352.648 170.975 356.994 170.975 356.994 170.975 356.994 164.118 356.994 164.118 356.994 164.118 356.994 164.118 356.705 164.118 356.125 163.82 355.545ZM164.118 358.153C180.814 358.153 180.814 358.153 180.814 358.153 180.814 366.557 180.814 366.557 180.814 366.557 166.801 366.557 166.801 366.557 166.801 366.557 165.012 363.659 164.416 360.761 164.118 358.153ZM170.975 371.483C169.783 370.324 168.59 369.165 167.696 368.006 167.696 368.006 167.398 367.716 167.398 367.716 170.975 367.716 170.975 367.716 170.975 367.716L170.975 371.483ZM183.199 368.006C181.112 370.614 178.13 373.222 175.447 374.67 175.447 374.67 175.447 374.67 175.447 374.67 175.447 374.67 175.149 374.67 175.447 374.67 174.255 374.091 173.36 373.511 172.168 372.642 172.168 367.716 172.168 367.716 172.168 367.716 183.199 367.716 183.199 367.716 183.199 367.716 183.199 367.716 183.199 368.006 183.199 368.006ZM184.093 366.557C182.006 366.557 182.006 366.557 182.006 366.557 182.006 358.153 182.006 358.153 182.006 358.153 186.478 358.153 186.478 358.153 186.478 358.153 186.18 360.761 185.584 363.659 184.093 366.557ZM186.478 356.994C172.168 356.994 172.168 356.994 172.168 356.994 172.168 352.068 172.168 352.068 172.168 352.068 172.168 352.068 172.168 352.068 172.168 352.068 173.36 351.489 174.255 350.909 175.149 350.04 175.149 350.04 175.149 350.04 175.447 350.04 175.745 350.04 175.745 350.04 175.745 350.04 177.832 352.068 182.006 354.097 186.478 354.966 186.776 355.256 186.776 355.545 186.776 355.545 186.478 356.125 186.478 356.705 186.478 356.994ZM196.317 346.852C193.932 345.983 188.863 344.534 186.478 343.085 181.41 340.767 179.323 339.028 177.534 337.869 176.938 337.29 176.043 337 175.149 337 175.149 337 175.149 337 175.149 337 175.149 337 175.149 337 175.149 337 174.255 337 173.36 337.29 172.466 337.869 170.677 339.028 168.888 340.767 163.82 343.085 161.137 344.534 156.366 345.983 153.683 346.852 152.193 347.432 151 348.881 151.298 350.619 151.596 355.545 153.087 365.977 156.366 372.352 159.944 379.597 169.484 385.392 173.062 387.42 173.658 388 174.553 388 175.149 388 175.745 388 176.342 388 176.938 387.42 180.814 385.392 190.056 379.597 193.932 372.352 197.211 365.977 198.404 355.545 199 350.619 199 348.881 198.106 347.432 196.317 346.852ZM191.845 371.193C189.46 375.83 184.093 380.756 175.745 385.392 175.447 385.682 175.149 385.682 175.149 385.682 174.851 385.682 174.553 385.682 174.553 385.392 166.205 380.756 160.839 375.83 158.453 371.193 155.174 364.818 153.981 353.517 153.683 350.33 153.683 349.46 154.28 349.17 154.578 349.17 155.472 348.881 155.472 348.881 155.472 348.881 158.155 347.722 162.329 346.562 164.714 345.403 169.484 343.085 171.571 341.347 173.36 340.188 173.658 339.898 173.658 339.898 173.957 339.608 174.255 339.608 174.553 339.318 174.851 339.318 174.851 339.318 174.851 339.318 174.851 339.318 175.149 339.318 175.149 339.318 175.149 339.318 175.149 339.318 175.149 339.318 175.149 339.318 175.745 339.318 176.043 339.608 176.043 339.608 176.342 339.898 176.64 339.898 176.938 340.188 178.727 341.347 180.814 343.085 185.286 345.403 187.671 346.562 191.845 347.722 194.826 348.881 195.72 349.17 195.72 349.17 195.72 349.17 195.72 349.17 196.615 349.46 196.615 350.33 196.317 353.517 195.124 364.818 191.845 371.193Z" fill="#484848" fill-rule="evenodd"/></g></svg>

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 175 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,14 @@
Additional Resources
====================
.. toctree::
:maxdepth: 1
endpoints
glossary
permissions
Console <https://console.otc.t-systems.com>
Health Dashboard <https://status.otc-service.com>
Health Dashboard Manual <https://docs.otc.t-systems.com/status-dashboard/umn/_static/OTC_Status_Dashboard_User_Guide.pdf>
Enterprise Dashboard <https://enterprise-dashboard.otc-service.com>
Security advisory </security/index>

File diff suppressed because it is too large Load Diff

View File

@ -3,5 +3,5 @@ Application
.. service_group:: .. service_group::
:class: service-group :class: service-group
:data: services.yaml :environment: internal
:category: application_services :service_category: application

View File

@ -3,5 +3,5 @@ Compute
.. service_group:: .. service_group::
:class: service-group :class: service-group
:data: services.yaml :service_category: compute
:category: compute :environment: internal

View File

@ -19,6 +19,7 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
smartquotes = False
otcdocs_repo_name = 'docs/docsportal' otcdocs_repo_name = 'docs/docsportal'
site_name = "Internal HelpCenter" site_name = "Internal HelpCenter"
@ -57,6 +58,8 @@ html_favicon = '_static/favicon.ico'
# Otherwise, the list of links for the User and Ops docs # Otherwise, the list of links for the User and Ops docs
# appear in the sidebar dropdown menu. # appear in the sidebar dropdown menu.
html_theme_options = { html_theme_options = {
'disable_search': True,
'logo_url': 'https://docs-int.otc-service.com',
'show_other_versions': False, 'show_other_versions': False,
'sidebar_mode': 'toctree', 'sidebar_mode': 'toctree',
'site_name': 'Internal HelpCenter', 'site_name': 'Internal HelpCenter',

7
doc/source/container.rst Normal file
View File

@ -0,0 +1,7 @@
Container
=========
.. service_group::
:class: service-group
:service_category: container
:environment: internal

View File

@ -1,7 +1,7 @@
Data Analysis Big Data and Data Analysis
============= ==========================
.. service_group:: .. service_group::
:class: service-group :class: service-group
:data: services.yaml :environment: internal
:category: data_analysis :service_category: big_data

View File

@ -3,5 +3,5 @@ Database
.. service_group:: .. service_group::
:class: service-group :class: service-group
:data: services.yaml :environment: internal
:category: database :service_category: database

View File

@ -3,5 +3,4 @@ REST API
.. navigator:: .. navigator::
:class: navigator-container :class: navigator-container
:data: services.yaml :document_type: api-ref
:link_type: api

View File

@ -0,0 +1,30 @@
.. _apig-en-api-180328005:
Generating an AK and SK
=======================
1. Log in to the management console.
2. Click the username and choose **My Credential** from the drop-down list.
3. Click **Access Keys**.
4. Click **Add Access Keys** to switch to the **Add Access Keys** page.
5. Enter your login password.
6. Enter the verification code sent to your mailbox or mobile phone.
.. note::
- Users that are created in IAM without specifying email addresses or mobile numbers only need to enter their login passwords.
- MyWorkplace users are not required to enter their login passwords. They can create new access keys without entering verification codes if no email addresses
or mobile numbers have been specified.
7. Click **OK** to download the access key.
.. note::
Keep the AK/SK file confidential to prevent information leakage.

View File

@ -0,0 +1,56 @@
AK/SK Authentication
====================
When you use API Gateway to send requests to underlying services, the requests must be signed using the AK and SK.
.. note::
AK is a unique identifier that is associated with a secret access key; the access key ID and secret access key are used together to sign requests
cryptographically.
SK is a key that is used in conjunction with an access key ID to cryptographically sign requests. Signing a request identifies the sender and prevents the
request from being altered.
The AK/SK authentication process is as follows:
.. _apig-en-api-180328004__li889518531076:
1. A standard request is created.
2. A to-be-signed string is created using the request and other related information.
.. _apig-en-api-180328004__li198402221915:
3. A signature is calculated using the AK/SK and to-be-signed string.
4. The generated signature is added as a header or a query parameter in the HTTP request.
5. After receiving the request, API Gateway performs
:ref:`1 <apig-en-api-180328004__li889518531076>` to
:ref:`3 <apig-en-api-180328004__li198402221915>` to calculate a signature.
6. The new signature is compared with the signature generated in
:ref:`3 <apig-en-api-180328004__li198402221915>`. If they are consistent, the request
is processed; otherwise, the request is rejected.
:ref:`Figure 1 <apig-en-api-180328004__fig104904517537>` shows the process of calling APIs through AK/SK authentication.
.. _apig-en-api-180328004__fig104904517537:
.. figure:: /_static/images/api_calling_process_flow.png
:alt: **Figure 1** API calling process flow
**Figure 1** API calling process flow
.. note::
- If a failure occurs in any step, the failure will be returned to the client application.
- The cached token is valid for 15 minutes by default.
.. toctree::
:maxdepth: 1
generating_an_ak_and_sk
signing_a_request
sample_code

View File

@ -0,0 +1,32 @@
Signing a Request
=================
.. _apig-en-api-180328006__li17137133433914:
1. Introduce the API Gateway signing SDK in the project.
a. Download the API Gateway signing tool from the following link:
..
https://apig-demo.obs.eu-de.otc.t-systems.com/java/java-sdk-core.zip
b. Decompress the downloaded package to obtain a **.jar** file.
c. Add the decompressed **.jar** file to a project, for example, Eclipse, as a dependency package. See the following figure.
.. figure:: /_static/images/sdkdemo_properties.png
2. Sign the request.
..
The signing method is integrated into the **.jar** file added in
:ref:`1 <apig-en-api-180328006__li17137133433914>`. Before sending the request, sign
the requested content. The signature obtained is included in the HTTP header of the request.
For details, see :ref:`Sample Code <apig-en-api-180328008>`.
.. important::
The JDK version cannot be earlier than 1.8.

View File

@ -0,0 +1,9 @@
Calling APIs
============
.. toctree::
:maxdepth: 1
obtaining_required_information
token_authentication
ak_sk_authentication/index

View File

@ -0,0 +1,75 @@
.. _apig-en-api-180328003:
Token Authentication
====================
Scenario
--------
If API requests are authenticated using tokens, the request header must contain **X-Auth-Token** (token information).
This section describes how to call an API to complete token authentication.
Procedure
---------
1. Send **POST https://**\ *IAM endpoint*\ **/v3/auth/tokens** to obtain the endpoint of IAM and the region name in the message body.
..
See `Regions and Endpoints <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__.
An example request is as follows:
.. note::
Replace the texts in italic with actual ones. For details, see *Identity and Access Management API Reference*.
Log in to the management console, click your username in the upper right corner, and choose **My Credential** from the drop-down list. On the **My
Credential** page, obtain your username, domain name, and project ID.
.. code-block:: json
{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "username", //Obtain your username from the My Credential page.
"password": "password",
"domain": {
"name": "domainname" //Obtain your domain name from the My Credential page.
}
}
}
},
"scope": {
"project": {
"id": "0215ef11e49d4743be23dd97a1561e91" //Obtain your project ID from the My Credential page.
}
}
}
}
.. _apig-en-api-180328003__li2615608112249:
2. Obtain the token. For details, see section "Obtaining the User Token" in the *Identity and Access Management API Reference*. If the request is successful, the
value of the X-Subject-Token header in the response is the token.
The following figures illustrate how to use Postman to manually obtain a token.
.. figure:: /_static/images/token_authentication_example_request.png
:alt: **Figure 1** Example request
**Figure 1** Exmple request
.. figure:: /_static/images/obtain_x-subject-token.png
:alt: **Figure 2** Obtain **X-Subject-Token** from the header of the response message.
**Figure 2** Obtain **X-Subject-Token** from the header of the response message.
3. Call a service API, add the **X-Auth-Token** header with the token obtained in
:ref:`2 <apig-en-api-180328003__li2615608112249>`.

View File

@ -0,0 +1,52 @@
HTTP Status Codes
=================
:ref:`Table 1 <apig-en-api-180328012__table11812530035>` describes common status codes.
.. _apig-en-api-180328012__table11812530035:
.. table:: **Table 1** User management permissions
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| **Return Value** | **Description** |
+=======================================+==========================================================================================================+
| 200 OK | The request has been processed successfully. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 204 No Content | The server does not return any information. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 400 Bad Request | The server failed to process the request. Possible causes include: |
| | |
| | 1. The request could not be parsed by the server due to incorrect syntax. |
| | |
| | 2. Request parameters are incorrect. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 401 Unauthorized | The request requires user authentication. For example, the username and password are required. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 403 Forbidden | You are forbidden to access the requested page. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 404 Not Found | The request failed because the requested resource could not be found on the server. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 405 Method Not Allowed | You are not allowed to use the method specified in the request. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 406 Not Acceptable | The response generated by the server could not be accepted by the client. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 407 Proxy Authentication Required | You must use the proxy server for authentication so that the request can be processed. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 408 Request Timeout | The request timed out. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 409 Conflict | The request could not be processed due to a conflict. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 410 Gone | The requested resource is not available on the server and no known forwarding address is provided. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 412 Precondition Failed | One or more conditions specified in the request header are not met when the server tests the conditions. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 500 Internal Server Error | The server failed to process the request due to an unexpected condition. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 501 Not Implemented | Failed to complete the request because the server does not support the requested function. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 502 Bad Gateway | Failed to complete the request because the server has received an invalid response. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 503 Service Unavailable | Failed to complete the request because the service is unavailable. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| 504 Gateway Timeout | The gateway timed out. |
+---------------------------------------+----------------------------------------------------------------------------------------------------------+

Some files were not shown because too many files have changed in this diff Show More