From f8d4fcc5a0bbcb0e5b21bfde43d5227cf83d35d4 Mon Sep 17 00:00:00 2001 From: Linas B Date: Wed, 28 Aug 2024 15:17:58 +0300 Subject: [PATCH 1/5] Added documentation for service endpoints --- apis/operations/description/Authorization.md | 5 + .../description/OrganizationAdministrator.md | 1 + .../description/ProjectsDeprecated.md | 5 + apis/operations/description/RateLimits.md | 3 + .../operations/description/RbacPermissions.md | 5 + .../description/iTwinsRBACPermission.md | 5 + services/access-control/v2/description.md | 1 + .../add-itwin-group-members/description.md | 11 + .../add-itwin-group-members/displayName.md | 1 + .../add-itwin-owner-member/description.md | 15 + .../add-itwin-owner-member/displayName.md | 1 + .../add-itwin-user-members/description.md | 13 + .../add-itwin-user-members/displayName.md | 1 + .../create-iTwin-role/description.md | 9 + .../create-iTwin-role/displayName.md | 1 + .../create-itwin-group/description.md | 15 + .../create-itwin-group/displayName.md | 1 + .../create-itwin-job/description.md | 19 + .../create-itwin-job/displayName.md | 1 + .../delete-iTwin-role/description.md | 9 + .../delete-iTwin-role/displayName.md | 1 + .../delete-itwin-group/description.md | 15 + .../delete-itwin-group/displayName.md | 1 + .../get-all-permissions/description.md | 11 + .../get-all-permissions/displayName.md | 1 + .../get-iTwin-permissions/description.md | 11 + .../get-iTwin-permissions/displayName.md | 1 + .../operations/get-iTwin-roles/description.md | 9 + .../operations/get-iTwin-roles/displayName.md | 1 + .../get-itwin-group-member/description.md | 13 + .../get-itwin-group-member/displayName.md | 1 + .../get-itwin-group-members/description.md | 13 + .../get-itwin-group-members/displayName.md | 1 + .../operations/get-itwin-group/description.md | 13 + .../operations/get-itwin-group/displayName.md | 1 + .../get-itwin-groups/description.md | 13 + .../get-itwin-groups/displayName.md | 1 + .../get-itwin-job-actions/description.md | 9 + .../get-itwin-job-actions/displayName.md | 1 + .../operations/get-itwin-job/description.md | 18 + .../operations/get-itwin-job/displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../get-itwin-owner-members/description.md | 34 + .../get-itwin-owner-members/displayName.md | 1 + .../operations/get-itwin-role/description.md | 9 + .../operations/get-itwin-role/displayName.md | 1 + .../get-itwin-user-member/description.md | 34 + .../get-itwin-user-member/displayName.md | 1 + .../get-itwin-user-members/description.md | 34 + .../get-itwin-user-members/displayName.md | 1 + .../remove-itwin-group-member/description.md | 9 + .../remove-itwin-group-member/displayName.md | 1 + .../remove-itwin-owner-member/description.md | 11 + .../remove-itwin-owner-member/displayName.md | 1 + .../remove-itwin-user-member/description.md | 9 + .../remove-itwin-user-member/displayName.md | 1 + .../update-iTwin-role/description.md | 9 + .../update-iTwin-role/displayName.md | 1 + .../update-itwin-group-member/description.md | 9 + .../update-itwin-group-member/displayName.md | 1 + .../update-itwin-group/description.md | 17 + .../update-itwin-group/displayName.md | 1 + .../update-itwin-user-member/description.md | 9 + .../update-itwin-user-member/displayName.md | 1 + services/carbon-calculation/v1/description.md | 1 + .../create-ec3-configuration/description.md | 11 + .../create-ec3-configuration/displayName.md | 1 + .../operations/create-ec3-job/description.md | 11 + .../operations/create-ec3-job/displayName.md | 1 + .../create-oneclicklca-job/description.md | 11 + .../create-oneclicklca-job/displayName.md | 1 + .../delete-ec3-configuration/description.md | 11 + .../delete-ec3-configuration/displayName.md | 1 + .../get-ec3-configuration/description.md | 11 + .../get-ec3-configuration/displayName.md | 1 + .../get-ec3-configurations/description.md | 11 + .../get-ec3-configurations/displayName.md | 1 + .../get-ec3-job-status/description.md | 11 + .../get-ec3-job-status/displayName.md | 1 + .../get-oneclicklca-job-status/description.md | 11 + .../get-oneclicklca-job-status/displayName.md | 1 + .../update-ec3-configuration/description.md | 11 + .../update-ec3-configuration/displayName.md | 1 + services/changed-elements/v2/description.md | 11 + .../create-comparison-job/description.md | 13 + .../create-comparison-job/displayName.md | 1 + .../delete-comparison-job/description.md | 9 + .../delete-comparison-job/displayName.md | 1 + .../get-comparison-job/description.md | 41 ++ .../get-comparison-job/displayName.md | 1 + services/clash-detection/v2/description.md | 1 + .../description.md | 11 + .../displayName.md | 1 + .../cancel-clashdetection-run/description.md | 9 + .../cancel-clashdetection-run/displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 11 + .../displayName.md | 1 + .../delete-clashdetection-run/description.md | 10 + .../delete-clashdetection-run/displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../delete-clashdetection-test/description.md | 9 + .../delete-clashdetection-test/displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../get-clashdetection-result/description.md | 9 + .../get-clashdetection-result/displayName.md | 1 + .../get-clashdetection-results/description.md | 7 + .../get-clashdetection-results/displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../get-clashdetection-test/description.md | 9 + .../get-clashdetection-test/displayName.md | 1 + .../get-clashdetection-tests/description.md | 9 + .../get-clashdetection-tests/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../description.md | 11 + .../displayName.md | 1 + .../run-clashdetection-test/description.md | 17 + .../run-clashdetection-test/displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../update-clashdetection-test/description.md | 14 + .../update-clashdetection-test/displayName.md | 1 + services/contextcapture/v1/description.md | 3 + .../v1/operations/jobs-create/description.md | 7 + .../v1/operations/jobs-create/displayName.md | 1 + .../v1/operations/jobs-delete/description.md | 7 + .../v1/operations/jobs-delete/displayName.md | 1 + .../v1/operations/jobs-get/description.md | 11 + .../v1/operations/jobs-get/displayName.md | 1 + .../v1/operations/jobs-patch/description.md | 7 + .../v1/operations/jobs-patch/displayName.md | 1 + .../operations/jobs-progress/description.md | 17 + .../operations/jobs-progress/displayName.md | 1 + .../operations/limits-engines/description.md | 11 + .../operations/limits-engines/displayName.md | 1 + .../workspaces-create/description.md | 7 + .../workspaces-create/displayName.md | 1 + .../workspaces-delete/description.md | 11 + .../workspaces-delete/displayName.md | 1 + .../operations/workspaces-get/description.md | 11 + .../operations/workspaces-get/displayName.md | 1 + services/echo/v2/description.md | 1 + .../context-nested-parameter/description.md | 1 + .../context-nested-parameter/displayName.md | 1 + .../context-parameter/description.md | 1 + .../context-parameter/displayName.md | 1 + .../echo/v2/operations/context/description.md | 1 + .../echo/v2/operations/context/displayName.md | 1 + services/export/v1/description.md | 1 + .../description.md | 14 + .../displayName.md | 1 + .../create-export-connection/description.md | 11 + .../create-export-connection/displayName.md | 1 + .../delete-export-connection/description.md | 8 + .../delete-export-connection/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../get-export-connection-run/description.md | 7 + .../get-export-connection-run/displayName.md | 1 + .../get-export-connection-runs/description.md | 7 + .../get-export-connection-runs/displayName.md | 1 + .../get-export-connection/description.md | 7 + .../get-export-connection/displayName.md | 1 + .../get-export-connections/description.md | 7 + .../get-export-connections/displayName.md | 1 + services/extensions/v1/description.md | 1 + .../create-extension-version/description.md | 7 + .../create-extension-version/displayName.md | 1 + .../create-private-extension/description.md | 7 + .../create-private-extension/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../delete-extension/description.md | 10 + .../delete-extension/displayName.md | 1 + .../get-extension-version/description.md | 7 + .../get-extension-version/displayName.md | 1 + .../get-extension-versions/description.md | 7 + .../get-extension-versions/displayName.md | 1 + .../operations/get-extensions/description.md | 7 + .../operations/get-extensions/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../update-extension/description.md | 7 + .../update-extension/displayName.md | 1 + services/forms/v1/description.md | 13 + .../add-attachment-to-form/description.md | 11 + .../add-attachment-to-form/displayName.md | 1 + .../add-comment-to-form/description.md | 11 + .../add-comment-to-form/displayName.md | 1 + .../create-form-data/description.md | 11 + .../create-form-data/displayName.md | 1 + .../delete-attachment/description.md | 11 + .../delete-attachment/displayName.md | 1 + .../operations/delete-comment/description.md | 11 + .../operations/delete-comment/displayName.md | 1 + .../delete-form-data/description.md | 11 + .../delete-form-data/displayName.md | 1 + .../download-form-as-file/description.md | 9 + .../download-form-as-file/displayName.md | 1 + .../export-form-to-storage/description.md | 13 + .../export-form-to-storage/displayName.md | 1 + .../get-attachment-file-by-id/description.md | 11 + .../get-attachment-file-by-id/displayName.md | 1 + .../description.md | 11 + .../displayName.md | 1 + .../get-form-data-attachments/description.md | 11 + .../get-form-data-attachments/displayName.md | 1 + .../get-form-data-comments/description.md | 11 + .../get-form-data-comments/displayName.md | 1 + .../get-form-data-details/description.md | 15 + .../get-form-data-details/displayName.md | 1 + .../get-form-definition-by-id/description.md | 7 + .../get-form-definition-by-id/displayName.md | 1 + .../operations/get-list-group/description.md | 11 + .../operations/get-list-group/displayName.md | 1 + .../get-project-form-data/description.md | 13 + .../get-project-form-data/displayName.md | 1 + .../description.md | 11 + .../displayName.md | 1 + .../get-static-image/description.md | 7 + .../get-static-image/displayName.md | 1 + .../v1/operations/get-workflow/description.md | 11 + .../v1/operations/get-workflow/displayName.md | 1 + .../update-form-data/description.md | 19 + .../update-form-data/displayName.md | 1 + .../upload-attachment-file/description.md | 11 + .../upload-attachment-file/displayName.md | 1 + .../grouping-and-mapping/v1/description.md | 1 + .../v1/operations/create-group/description.md | 29 + .../v1/operations/create-group/displayName.md | 1 + .../operations/create-mapping/description.md | 25 + .../operations/create-mapping/displayName.md | 1 + .../operations/create-property/description.md | 27 + .../operations/create-property/displayName.md | 1 + .../v1/operations/delete-group/description.md | 13 + .../v1/operations/delete-group/displayName.md | 1 + .../operations/delete-mapping/description.md | 13 + .../operations/delete-mapping/displayName.md | 1 + .../operations/delete-property/description.md | 13 + .../operations/delete-property/displayName.md | 1 + .../get-audittrail-imodel/description.md | 13 + .../get-audittrail-imodel/displayName.md | 1 + .../get-cdm-partition/description.md | 13 + .../get-cdm-partition/displayName.md | 1 + .../v1/operations/get-cdm/description.md | 11 + .../v1/operations/get-cdm/displayName.md | 1 + .../get-extraction-logs/description.md | 11 + .../get-extraction-logs/displayName.md | 1 + .../get-extraction-status/description.md | 11 + .../get-extraction-status/displayName.md | 1 + .../v1/operations/get-group/description.md | 13 + .../v1/operations/get-group/displayName.md | 1 + .../v1/operations/get-groups/description.md | 22 + .../v1/operations/get-groups/displayName.md | 1 + .../get-imodel-extractions/description.md | 11 + .../get-imodel-extractions/displayName.md | 1 + .../get-mapping-extractions/description.md | 11 + .../get-mapping-extractions/displayName.md | 1 + .../v1/operations/get-mapping/description.md | 11 + .../v1/operations/get-mapping/displayName.md | 1 + .../v1/operations/get-mappings/description.md | 11 + .../v1/operations/get-mappings/displayName.md | 1 + .../operations/get-properties/description.md | 19 + .../operations/get-properties/displayName.md | 1 + .../v1/operations/get-property/description.md | 19 + .../v1/operations/get-property/displayName.md | 1 + .../operations/run-extraction/description.md | 24 + .../operations/run-extraction/displayName.md | 1 + .../v1/operations/update-group/description.md | 15 + .../v1/operations/update-group/displayName.md | 1 + .../operations/update-mapping/description.md | 15 + .../operations/update-mapping/displayName.md | 1 + .../operations/update-property/description.md | 27 + .../operations/update-property/displayName.md | 1 + .../operations/rpc-version-get/description.md | 0 .../operations/rpc-version-get/displayName.md | 1 + .../v1/operations/rpc-version/description.md | 0 .../v1/operations/rpc-version/displayName.md | 1 + services/imodels-odata/v1/description.md | 1 + .../mapping-odata-entity/description.md | 17 + .../mapping-odata-entity/displayName.md | 1 + .../mapping-odata-metadata/description.md | 17 + .../mapping-odata-metadata/displayName.md | 1 + .../operations/mapping-odata/description.md | 17 + .../operations/mapping-odata/displayName.md | 1 + services/imodels/v2/description.md | 5 + .../acquire-imodel-briefcase/description.md | 17 + .../acquire-imodel-briefcase/displayName.md | 1 + .../v2/operations/clone-imodel/description.md | 48 ++ .../v2/operations/clone-imodel/displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../description.md | 15 + .../displayName.md | 1 + .../description.md | 21 + .../displayName.md | 1 + .../create-imodel-changeset/description.md | 28 + .../create-imodel-changeset/displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../create-imodel-share/description.md | 18 + .../create-imodel-share/displayName.md | 1 + .../operations/create-imodel/description.md | 44 ++ .../operations/create-imodel/displayName.md | 1 + .../operations/delete-imodel/description.md | 11 + .../operations/delete-imodel/displayName.md | 1 + .../v2/operations/fork-imodel/description.md | 52 ++ .../v2/operations/fork-imodel/displayName.md | 1 + .../get-briefcase-checkpoint/description.md | 20 + .../get-briefcase-checkpoint/displayName.md | 1 + .../get-changeset-checkpoint/description.md | 20 + .../get-changeset-checkpoint/displayName.md | 1 + .../description.md | 21 + .../displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../get-imodel-briefcases/description.md | 22 + .../get-imodel-briefcases/displayName.md | 1 + .../description.md | 15 + .../displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../get-imodel-changesets/description.md | 25 + .../get-imodel-changesets/displayName.md | 1 + .../get-imodel-details/description.md | 11 + .../get-imodel-details/displayName.md | 1 + .../get-imodel-locks/description.md | 18 + .../get-imodel-locks/displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../get-imodel-named-versions/description.md | 22 + .../get-imodel-named-versions/displayName.md | 1 + .../get-imodel-permissions/description.md | 21 + .../get-imodel-permissions/displayName.md | 1 + .../description.md | 25 + .../displayName.md | 1 + .../get-imodel-share/description.md | 18 + .../get-imodel-share/displayName.md | 1 + .../get-imodel-shares/description.md | 18 + .../get-imodel-shares/displayName.md | 1 + .../get-imodel-thumbnail/description.md | 14 + .../get-imodel-thumbnail/displayName.md | 1 + .../get-imodel-user-details/description.md | 11 + .../get-imodel-user-details/displayName.md | 1 + .../description.md | 25 + .../displayName.md | 1 + .../get-imodel-users/description.md | 20 + .../get-imodel-users/displayName.md | 1 + .../get-itwin-imodels/description.md | 20 + .../get-itwin-imodels/displayName.md | 1 + .../description.md | 19 + .../displayName.md | 1 + .../release-imodel-briefcase/description.md | 19 + .../release-imodel-briefcase/displayName.md | 1 + .../revoke-imodel-share/description.md | 18 + .../revoke-imodel-share/displayName.md | 1 + .../description.md | 15 + .../displayName.md | 1 + .../update-imodel-changeset/description.md | 11 + .../update-imodel-changeset/displayName.md | 1 + .../update-imodel-locks/description.md | 22 + .../update-imodel-locks/displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../description.md | 27 + .../displayName.md | 1 + .../update-imodel-share/description.md | 18 + .../update-imodel-share/displayName.md | 1 + .../description.md | 27 + .../displayName.md | 1 + .../operations/update-imodel/description.md | 11 + .../operations/update-imodel/displayName.md | 1 + .../upload-imodel-thumbnail/description.md | 11 + .../upload-imodel-thumbnail/displayName.md | 1 + services/issues/v1/description.md | 9 + .../add-attachment-to-issue/description.md | 11 + .../add-attachment-to-issue/displayName.md | 1 + .../add-comment-to-issue/description.md | 11 + .../add-comment-to-issue/displayName.md | 1 + .../v1/operations/create-issue/description.md | 11 + .../v1/operations/create-issue/displayName.md | 1 + .../delete-attachment/description.md | 11 + .../delete-attachment/displayName.md | 1 + .../operations/delete-comment/description.md | 11 + .../operations/delete-comment/displayName.md | 1 + .../v1/operations/delete-issue/description.md | 11 + .../v1/operations/delete-issue/displayName.md | 1 + .../download-issue-as-file/description.md | 9 + .../download-issue-as-file/displayName.md | 1 + .../export-issues-to-storage/description.md | 13 + .../export-issues-to-storage/displayName.md | 1 + .../get-attachment-by-id/description.md | 11 + .../get-attachment-by-id/displayName.md | 1 + .../get-form-definition-by-id/description.md | 7 + .../get-form-definition-by-id/displayName.md | 1 + .../get-issue-attachments/description.md | 11 + .../get-issue-attachments/displayName.md | 1 + .../get-issue-audit-trail/description.md | 11 + .../get-issue-audit-trail/displayName.md | 1 + .../get-issue-comments/description.md | 11 + .../get-issue-comments/displayName.md | 1 + .../get-issue-details/description.md | 15 + .../get-issue-details/displayName.md | 1 + .../operations/get-list-group/description.md | 11 + .../operations/get-list-group/displayName.md | 1 + .../description.md | 11 + .../displayName.md | 1 + .../get-project-issues/description.md | 13 + .../get-project-issues/displayName.md | 1 + .../get-static-image/description.md | 7 + .../get-static-image/displayName.md | 1 + .../v1/operations/get-workflow/description.md | 11 + .../v1/operations/get-workflow/displayName.md | 1 + .../v1/operations/modify-issue/description.md | 19 + .../v1/operations/modify-issue/displayName.md | 1 + .../upload-attachment-file/description.md | 11 + .../upload-attachment-file/displayName.md | 1 + services/itwin-entities/v1/description.md | 1 + .../operations/create-entity/description.md | 9 + .../operations/create-entity/displayName.md | 1 + .../create-hierarchy-nodes/description.md | 9 + .../create-hierarchy-nodes/displayName.md | 1 + .../create-hierarchy/description.md | 9 + .../create-hierarchy/displayName.md | 1 + .../v1/operations/create-link/description.md | 9 + .../v1/operations/create-link/displayName.md | 1 + .../operations/delete-entity/description.md | 9 + .../operations/delete-entity/displayName.md | 1 + .../delete-hierarchy-node/description.md | 9 + .../delete-hierarchy-node/displayName.md | 1 + .../delete-hierarchy/description.md | 9 + .../delete-hierarchy/displayName.md | 1 + .../v1/operations/delete-link/description.md | 9 + .../v1/operations/delete-link/displayName.md | 1 + .../v1/operations/get-entities/description.md | 9 + .../v1/operations/get-entities/displayName.md | 1 + .../v1/operations/get-entity/description.md | 9 + .../v1/operations/get-entity/displayName.md | 1 + .../operations/get-hierarchies/description.md | 9 + .../operations/get-hierarchies/displayName.md | 1 + .../get-hierarchy-nodes/description.md | 9 + .../get-hierarchy-nodes/displayName.md | 1 + .../operations/get-hierarchy/description.md | 9 + .../operations/get-hierarchy/displayName.md | 1 + .../v1/operations/get-links/description.md | 9 + .../v1/operations/get-links/displayName.md | 1 + .../operations/update-entity/description.md | 9 + .../operations/update-entity/displayName.md | 1 + .../update-hierarchy/description.md | 9 + .../update-hierarchy/displayName.md | 1 + services/itwin-search/v1/description.md | 1 + .../v1/operations/discover/description.md | 9 + .../v1/operations/discover/displayName.md | 1 + .../v1/operations/post-search/description.md | 9 + .../v1/operations/post-search/displayName.md | 1 + services/itwins/v1/description.md | 1 + .../add-itwin-to-my-favorites/description.md | 9 + .../add-itwin-to-my-favorites/displayName.md | 1 + .../add-itwin-to-my-recents/description.md | 9 + .../add-itwin-to-my-recents/displayName.md | 1 + .../v1/operations/create-itwin/description.md | 16 + .../v1/operations/create-itwin/displayName.md | 1 + .../create-repository/description.md | 26 + .../create-repository/displayName.md | 1 + .../delete-itwin-image/description.md | 14 + .../delete-itwin-image/displayName.md | 1 + .../v1/operations/delete-itwin/description.md | 12 + .../v1/operations/delete-itwin/displayName.md | 1 + .../delete-repository/description.md | 16 + .../delete-repository/displayName.md | 1 + .../get-itwin-account/description.md | 9 + .../get-itwin-account/displayName.md | 1 + .../operations/get-itwin-image/description.md | 13 + .../operations/get-itwin-image/displayName.md | 1 + .../v1/operations/get-itwin/description.md | 9 + .../v1/operations/get-itwin/displayName.md | 1 + .../get-my-favorite-itwins/description.md | 11 + .../get-my-favorite-itwins/displayName.md | 1 + .../operations/get-my-itwins/description.md | 11 + .../operations/get-my-itwins/displayName.md | 1 + .../get-my-primary-account/description.md | 13 + .../get-my-primary-account/displayName.md | 1 + .../description.md | 11 + .../displayName.md | 1 + .../description.md | 48 ++ .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../v1/operations/update-itwin/description.md | 16 + .../v1/operations/update-itwin/displayName.md | 1 + .../upload-itwin-image/description.md | 26 + .../upload-itwin-image/displayName.md | 1 + services/library/v1/description.md | 3 + .../create-application/description.md | 11 + .../create-application/displayName.md | 1 + .../create-catalog-document/description.md | 23 + .../create-catalog-document/displayName.md | 1 + .../create-catalog-weblink/description.md | 15 + .../create-catalog-weblink/displayName.md | 1 + .../operations/create-catalog/description.md | 11 + .../operations/create-catalog/displayName.md | 1 + .../operations/create-category/description.md | 11 + .../operations/create-category/displayName.md | 1 + .../create-component-document/description.md | 28 + .../create-component-document/displayName.md | 1 + .../create-component-variation/description.md | 22 + .../create-component-variation/displayName.md | 1 + .../create-component-weblink/description.md | 15 + .../create-component-weblink/displayName.md | 1 + .../create-component/description.md | 26 + .../create-component/displayName.md | 1 + .../create-manufacturer/description.md | 11 + .../create-manufacturer/displayName.md | 1 + .../delete-application/description.md | 11 + .../delete-application/displayName.md | 1 + .../delete-catalog-document/description.md | 11 + .../delete-catalog-document/displayName.md | 1 + .../delete-catalog-weblink/description.md | 11 + .../delete-catalog-weblink/displayName.md | 1 + .../operations/delete-catalog/description.md | 11 + .../operations/delete-catalog/displayName.md | 1 + .../operations/delete-category/description.md | 11 + .../operations/delete-category/displayName.md | 1 + .../delete-component-document/description.md | 11 + .../delete-component-document/displayName.md | 1 + .../delete-component-variation/description.md | 11 + .../delete-component-variation/displayName.md | 1 + .../delete-component-weblink/description.md | 11 + .../delete-component-weblink/displayName.md | 1 + .../delete-component/description.md | 11 + .../delete-component/displayName.md | 1 + .../delete-manufacturer/description.md | 11 + .../delete-manufacturer/displayName.md | 1 + .../download-analytics/description.md | 12 + .../download-analytics/displayName.md | 1 + .../operations/get-application/description.md | 11 + .../operations/get-application/displayName.md | 1 + .../get-applications/description.md | 15 + .../get-applications/displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../get-brand-components/description.md | 9 + .../get-brand-components/displayName.md | 1 + .../v1/operations/get-brand/description.md | 9 + .../v1/operations/get-brand/displayName.md | 1 + .../v1/operations/get-brands/description.md | 15 + .../v1/operations/get-brands/displayName.md | 1 + .../get-catalog-document/description.md | 15 + .../get-catalog-document/displayName.md | 1 + .../get-catalog-documents/description.md | 15 + .../get-catalog-documents/displayName.md | 1 + .../get-catalog-weblink/description.md | 11 + .../get-catalog-weblink/displayName.md | 1 + .../get-catalog-weblinks/description.md | 11 + .../get-catalog-weblinks/displayName.md | 1 + .../v1/operations/get-catalog/description.md | 11 + .../v1/operations/get-catalog/displayName.md | 1 + .../v1/operations/get-catalogs/description.md | 17 + .../v1/operations/get-catalogs/displayName.md | 1 + .../operations/get-categories/description.md | 15 + .../operations/get-categories/displayName.md | 1 + .../v1/operations/get-category/description.md | 11 + .../v1/operations/get-category/displayName.md | 1 + .../get-component-document/description.md | 15 + .../get-component-document/displayName.md | 1 + .../get-component-documents/description.md | 15 + .../get-component-documents/displayName.md | 1 + .../get-component-variation/description.md | 11 + .../get-component-variation/displayName.md | 1 + .../get-component-variations/description.md | 11 + .../get-component-variations/displayName.md | 1 + .../get-component-weblink/description.md | 11 + .../get-component-weblink/displayName.md | 1 + .../get-component-weblinks/description.md | 11 + .../get-component-weblinks/displayName.md | 1 + .../operations/get-component/description.md | 11 + .../operations/get-component/displayName.md | 1 + .../operations/get-components/description.md | 17 + .../operations/get-components/displayName.md | 1 + .../v1/operations/get-job/description.md | 23 + .../v1/operations/get-job/displayName.md | 1 + .../get-manufacturer/description.md | 11 + .../get-manufacturer/displayName.md | 1 + .../get-manufacturers/description.md | 15 + .../get-manufacturers/displayName.md | 1 + .../update-application/description.md | 15 + .../update-application/displayName.md | 1 + .../update-catalog-document/description.md | 19 + .../update-catalog-document/displayName.md | 1 + .../update-catalog-weblink/description.md | 15 + .../update-catalog-weblink/displayName.md | 1 + .../operations/update-catalog/description.md | 15 + .../operations/update-catalog/displayName.md | 1 + .../operations/update-category/description.md | 11 + .../operations/update-category/displayName.md | 1 + .../update-component-document/description.md | 25 + .../update-component-document/displayName.md | 1 + .../update-component-variation/description.md | 22 + .../update-component-variation/displayName.md | 1 + .../update-component-weblink/description.md | 15 + .../update-component-weblink/displayName.md | 1 + .../update-component/description.md | 25 + .../update-component/displayName.md | 1 + .../update-manufacturer/description.md | 15 + .../update-manufacturer/displayName.md | 1 + .../upload-component/description.md | 23 + .../upload-component/displayName.md | 1 + services/mesh-export/v1/description.md | 1 + .../operations/delete-export/description.md | 7 + .../operations/delete-export/displayName.md | 1 + .../v1/operations/get-export/description.md | 18 + .../v1/operations/get-export/displayName.md | 1 + .../v1/operations/get-exports/description.md | 7 + .../v1/operations/get-exports/displayName.md | 1 + .../v1/operations/start-export/description.md | 18 + .../v1/operations/start-export/displayName.md | 1 + .../v1/operations/create-group/description.md | 13 + .../v1/operations/create-group/displayName.md | 1 + .../v1/operations/delete-group/description.md | 13 + .../v1/operations/delete-group/displayName.md | 1 + .../v1/operations/get-group/description.md | 13 + .../v1/operations/get-group/displayName.md | 1 + .../get-itwin-groups/description.md | 22 + .../get-itwin-groups/displayName.md | 1 + .../v1/operations/update-group/description.md | 13 + .../v1/operations/update-group/displayName.md | 1 + services/pnid-to-itwin/v2/description.md | 1 + .../create-inference-run/description.md | 7 + .../create-inference-run/displayName.md | 1 + .../create-inference/description.md | 6 + .../create-inference/displayName.md | 1 + .../delete-inference-input/description.md | 7 + .../delete-inference-input/displayName.md | 1 + .../delete-inference-run/description.md | 7 + .../delete-inference-run/displayName.md | 1 + .../delete-inference/description.md | 7 + .../delete-inference/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../get-inference-inputs/description.md | 7 + .../get-inference-inputs/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../get-inference-run-results/description.md | 7 + .../get-inference-run-results/displayName.md | 1 + .../get-inference-run/description.md | 7 + .../get-inference-run/displayName.md | 1 + .../operations/get-inference/description.md | 7 + .../operations/get-inference/displayName.md | 1 + .../get-itwin-inferences/description.md | 7 + .../get-itwin-inferences/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + services/projects/v1/description.md | 3 + .../add-project-team-member/description.md | 21 + .../add-project-team-member/displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../add-project-to-my-recents/description.md | 9 + .../add-project-to-my-recents/displayName.md | 1 + .../create-project-role/description.md | 15 + .../create-project-role/displayName.md | 1 + .../operations/create-project/description.md | 18 + .../operations/create-project/displayName.md | 1 + .../delete-project-role/description.md | 11 + .../delete-project-role/displayName.md | 1 + .../operations/delete-project/description.md | 18 + .../operations/delete-project/displayName.md | 1 + .../get-my-favorite-projects/description.md | 15 + .../get-my-favorite-projects/displayName.md | 1 + .../description.md | 15 + .../displayName.md | 1 + .../get-project-roles/description.md | 11 + .../get-project-roles/displayName.md | 1 + .../description.md | 15 + .../displayName.md | 1 + .../get-project-team-members/description.md | 22 + .../get-project-team-members/displayName.md | 1 + .../v1/operations/get-project/description.md | 15 + .../v1/operations/get-project/displayName.md | 1 + .../get-user-permissions/description.md | 9 + .../get-user-permissions/displayName.md | 1 + .../v1/operations/my-projects/description.md | 21 + .../v1/operations/my-projects/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../remove-project-team-member/description.md | 9 + .../remove-project-team-member/displayName.md | 1 + .../update-project-role/description.md | 16 + .../update-project-role/displayName.md | 1 + .../description.md | 15 + .../displayName.md | 1 + .../operations/update-project/description.md | 20 + .../operations/update-project/displayName.md | 1 + .../projectwise365-insights/v1/description.md | 3 + .../project-metadata/description.md | 15 + .../project-metadata/displayName.md | 1 + .../operations/project-odata/description.md | 15 + .../operations/project-odata/displayName.md | 1 + .../operations/project-schema/description.md | 15 + .../operations/project-schema/displayName.md | 1 + services/reality-data/v1/description.md | 3 + .../associate-to-project/description.md | 11 + .../associate-to-project/displayName.md | 1 + .../create-reality-data/description.md | 21 + .../create-reality-data/displayName.md | 1 + .../delete-reality-data/description.md | 13 + .../delete-reality-data/displayName.md | 1 + .../dissociate-from-project/description.md | 11 + .../dissociate-from-project/displayName.md | 1 + .../get-all-reality-data/description.md | 29 + .../get-all-reality-data/displayName.md | 1 + .../get-reality-data-container/description.md | 27 + .../get-reality-data-container/displayName.md | 1 + .../get-reality-data-details/description.md | 13 + .../get-reality-data-details/displayName.md | 1 + .../get-reality-data-projects/description.md | 15 + .../get-reality-data-projects/displayName.md | 1 + .../update-reality-data/description.md | 15 + .../update-reality-data/displayName.md | 1 + services/reality-management/v1/description.md | 3 + .../associate-to-iTwin/description.md | 11 + .../associate-to-iTwin/displayName.md | 1 + .../create-reality-data/description.md | 21 + .../create-reality-data/displayName.md | 1 + .../delete-reality-data/description.md | 13 + .../delete-reality-data/displayName.md | 1 + .../dissociate-from-iTwin/description.md | 11 + .../dissociate-from-iTwin/displayName.md | 1 + .../get-all-reality-data/description.md | 28 + .../get-all-reality-data/displayName.md | 1 + .../description.md | 26 + .../displayName.md | 1 + .../get-reality-data-details/description.md | 13 + .../get-reality-data-details/displayName.md | 1 + .../get-reality-data-iTwins/description.md | 13 + .../get-reality-data-iTwins/displayName.md | 1 + .../description.md | 26 + .../displayName.md | 1 + .../update-reality-data/description.md | 15 + .../update-reality-data/displayName.md | 1 + services/realityconversion/v1/description.md | 1 + .../v1/operations/jobs-create/description.md | 8 + .../v1/operations/jobs-create/displayName.md | 1 + .../v1/operations/jobs-delete/description.md | 7 + .../v1/operations/jobs-delete/displayName.md | 1 + .../v1/operations/jobs-get/description.md | 7 + .../v1/operations/jobs-get/displayName.md | 1 + .../v1/operations/jobs-patch/description.md | 7 + .../v1/operations/jobs-patch/displayName.md | 1 + .../operations/jobs-progress/description.md | 7 + .../operations/jobs-progress/displayName.md | 1 + .../realitydataanalysis/v1/description.md | 3 + .../v1/operations/jobs-create/description.md | 7 + .../v1/operations/jobs-create/displayName.md | 1 + .../v1/operations/jobs-delete/description.md | 7 + .../v1/operations/jobs-delete/displayName.md | 1 + .../v1/operations/jobs-get-all/description.md | 9 + .../v1/operations/jobs-get-all/displayName.md | 1 + .../v1/operations/jobs-get/description.md | 11 + .../v1/operations/jobs-get/displayName.md | 1 + .../v1/operations/jobs-patch/description.md | 9 + .../v1/operations/jobs-patch/displayName.md | 1 + .../operations/jobs-progress/description.md | 17 + .../operations/jobs-progress/displayName.md | 1 + services/reporting/v2/description.md | 4 + .../operations/create-apikey/description.md | 15 + .../operations/create-apikey/displayName.md | 1 + .../create-report-mapping/description.md | 11 + .../create-report-mapping/displayName.md | 1 + .../operations/create-report/description.md | 11 + .../operations/create-report/displayName.md | 1 + .../delete-report-mapping/description.md | 11 + .../delete-report-mapping/displayName.md | 1 + .../operations/delete-report/description.md | 11 + .../operations/delete-report/displayName.md | 1 + .../v2/operations/get-apikey/description.md | 9 + .../v2/operations/get-apikey/displayName.md | 1 + .../v2/operations/get-apikeys/description.md | 9 + .../v2/operations/get-apikeys/displayName.md | 1 + .../get-itwin-reports/description.md | 11 + .../get-itwin-reports/displayName.md | 1 + .../get-report-mappings/description.md | 11 + .../get-report-mappings/displayName.md | 1 + .../v2/operations/get-report/description.md | 11 + .../v2/operations/get-report/displayName.md | 1 + .../v2/operations/odata-entity/description.md | 13 + .../v2/operations/odata-entity/displayName.md | 1 + .../operations/odata-metadata/description.md | 13 + .../operations/odata-metadata/displayName.md | 1 + .../v2/operations/odata/description.md | 13 + .../v2/operations/odata/displayName.md | 1 + .../operations/revoke-apikey/description.md | 9 + .../operations/revoke-apikey/displayName.md | 1 + .../operations/update-apikey/description.md | 9 + .../operations/update-apikey/displayName.md | 1 + .../operations/update-report/description.md | 11 + .../operations/update-report/displayName.md | 1 + services/savedviews/v1/description.md | 2 + .../v1/operations/add-image/description.md | 7 + .../v1/operations/add-image/displayName.md | 1 + .../create-extension/description.md | 602 ++++++++++++++++++ .../create-extension/displayName.md | 1 + .../v1/operations/create-group/description.md | 9 + .../v1/operations/create-group/displayName.md | 1 + .../create-savedview/description.md | 9 + .../create-savedview/displayName.md | 1 + .../v1/operations/create-tag/description.md | 9 + .../v1/operations/create-tag/displayName.md | 1 + .../delete-extension/description.md | 7 + .../delete-extension/displayName.md | 1 + .../v1/operations/delete-group/description.md | 7 + .../v1/operations/delete-group/displayName.md | 1 + .../delete-savedview/description.md | 7 + .../delete-savedview/displayName.md | 1 + .../v1/operations/delete-tag/description.md | 7 + .../v1/operations/delete-tag/displayName.md | 1 + .../get-all-extensions/description.md | 7 + .../get-all-extensions/displayName.md | 1 + .../operations/get-all-groups/description.md | 7 + .../operations/get-all-groups/displayName.md | 1 + .../get-all-savedviews/description.md | 13 + .../get-all-savedviews/displayName.md | 1 + .../v1/operations/get-all-tags/description.md | 7 + .../v1/operations/get-all-tags/displayName.md | 1 + .../operations/get-extension/description.md | 7 + .../operations/get-extension/displayName.md | 1 + .../v1/operations/get-group/description.md | 7 + .../v1/operations/get-group/displayName.md | 1 + .../v1/operations/get-image/description.md | 7 + .../v1/operations/get-image/displayName.md | 1 + .../operations/get-savedview/description.md | 7 + .../operations/get-savedview/displayName.md | 1 + .../v1/operations/get-tag/description.md | 7 + .../v1/operations/get-tag/displayName.md | 1 + .../v1/operations/update-group/description.md | 9 + .../v1/operations/update-group/displayName.md | 1 + .../update-savedview/description.md | 9 + .../update-savedview/displayName.md | 1 + .../v1/operations/update-tag/description.md | 9 + .../v1/operations/update-tag/displayName.md | 1 + services/sensor-data/v1/description.md | 1 + .../v1/operations/get-nodes/description.md | 11 + .../v1/operations/get-nodes/displayName.md | 1 + .../process-integration/description.md | 7 + .../process-integration/displayName.md | 1 + .../operations/query-raw-data/description.md | 11 + .../operations/query-raw-data/displayName.md | 1 + .../v1/operations/remove-data/description.md | 11 + .../v1/operations/remove-data/displayName.md | 1 + .../v1/operations/upload-data/description.md | 7 + .../v1/operations/upload-data/displayName.md | 1 + services/storage-container/v1/description.md | 1 + .../clone-storage-container/description.md | 7 + .../clone-storage-container/displayName.md | 1 + .../create-storage-container/description.md | 7 + .../create-storage-container/displayName.md | 1 + .../delete-storage-container/description.md | 7 + .../delete-storage-container/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../get-storage-containers/description.md | 7 + .../get-storage-containers/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + services/storage/v1/description.md | 1 + .../complete-file-creation/description.md | 9 + .../complete-file-creation/displayName.md | 1 + .../v1/operations/create-file/description.md | 24 + .../v1/operations/create-file/displayName.md | 1 + .../operations/create-folder/description.md | 16 + .../operations/create-folder/displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../v1/operations/delete-file/description.md | 13 + .../v1/operations/delete-file/displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../operations/delete-folder/description.md | 13 + .../operations/delete-folder/displayName.md | 1 + .../operations/download-file/description.md | 13 + .../operations/download-file/displayName.md | 1 + .../v1/operations/get-file/description.md | 9 + .../v1/operations/get-file/displayName.md | 1 + .../get-files-in-folder/description.md | 9 + .../get-files-in-folder/displayName.md | 1 + .../v1/operations/get-folder/description.md | 9 + .../v1/operations/get-folder/displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../get-folders-in-folder/description.md | 9 + .../get-folders-in-folder/displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../lock-files-in-folder/description.md | 9 + .../lock-files-in-folder/displayName.md | 1 + .../move-file-legacy/description.md | 9 + .../move-file-legacy/displayName.md | 1 + .../v1/operations/move-file/description.md | 9 + .../v1/operations/move-file/displayName.md | 1 + .../v1/operations/move-folder/description.md | 9 + .../v1/operations/move-folder/displayName.md | 1 + .../v1/operations/restore-file/description.md | 9 + .../v1/operations/restore-file/displayName.md | 1 + .../operations/restore-folder/description.md | 9 + .../operations/restore-folder/displayName.md | 1 + .../description.md | 13 + .../displayName.md | 1 + .../unlock-files-in-folder/description.md | 9 + .../unlock-files-in-folder/displayName.md | 1 + .../update-file-content/description.md | 16 + .../update-file-content/displayName.md | 1 + .../v1/operations/update-file/description.md | 17 + .../v1/operations/update-file/displayName.md | 1 + .../operations/update-folder/description.md | 16 + .../operations/update-folder/displayName.md | 1 + services/synchronization/v1/description.md | 1 + .../description.md | 10 + .../displayName.md | 1 + .../description.md | 10 + .../displayName.md | 1 + .../description.md | 55 ++ .../displayName.md | 1 + .../description.md | 27 + .../displayName.md | 1 + .../create-itwin-configuration/description.md | 44 ++ .../create-itwin-configuration/displayName.md | 1 + .../description.md | 12 + .../displayName.md | 1 + .../create-manifest-connection/description.md | 11 + .../create-manifest-connection/displayName.md | 1 + .../create-storage-connection/description.md | 11 + .../create-storage-connection/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../delete-itwin-configuration/description.md | 7 + .../delete-itwin-configuration/displayName.md | 1 + .../delete-manifest-connection/description.md | 8 + .../delete-manifest-connection/displayName.md | 1 + .../delete-storage-connection/description.md | 8 + .../delete-storage-connection/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../operations/get-connections/description.md | 16 + .../operations/get-connections/displayName.md | 1 + .../get-imodel-configuration/description.md | 7 + .../get-imodel-configuration/displayName.md | 1 + .../get-itwin-configuration/description.md | 7 + .../get-itwin-configuration/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../description.md | 16 + .../displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../description.md | 16 + .../displayName.md | 1 + .../get-manifest-connection/description.md | 7 + .../get-manifest-connection/displayName.md | 1 + .../get-manifest-connections/description.md | 16 + .../get-manifest-connections/displayName.md | 1 + .../get-storage-connection-run/description.md | 7 + .../get-storage-connection-run/displayName.md | 1 + .../description.md | 16 + .../displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../description.md | 16 + .../displayName.md | 1 + .../get-storage-connection/description.md | 7 + .../get-storage-connection/displayName.md | 1 + .../get-storage-connections/description.md | 16 + .../get-storage-connections/displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../patch-imodel-configuration/description.md | 7 + .../patch-imodel-configuration/displayName.md | 1 + .../patch-itwin-configuration/description.md | 7 + .../patch-itwin-configuration/displayName.md | 1 + .../description.md | 8 + .../displayName.md | 1 + .../description.md | 8 + .../displayName.md | 1 + .../run-storage-connection/description.md | 12 + .../run-storage-connection/displayName.md | 1 + .../description.md | 10 + .../displayName.md | 1 + .../update-manifest-connection/description.md | 11 + .../update-manifest-connection/displayName.md | 1 + .../description.md | 10 + .../displayName.md | 1 + .../update-storage-connection/description.md | 11 + .../update-storage-connection/displayName.md | 1 + services/transformations/v1/description.md | 3 + .../operations/alignimodeldata/description.md | 64 ++ .../operations/alignimodeldata/displayName.md | 1 + .../operations/combineimodels/description.md | 54 ++ .../operations/combineimodels/displayName.md | 1 + .../combinephysicalmodels/description.md | 28 + .../combinephysicalmodels/displayName.md | 1 + .../combinephysicalmodelsv2/description.md | 30 + .../combinephysicalmodelsv2/displayName.md | 1 + .../create-transformation/description.md | 19 + .../create-transformation/displayName.md | 1 + .../v1/operations/createfork/description.md | 27 + .../v1/operations/createfork/displayName.md | 1 + .../delete-configuration/description.md | 11 + .../delete-configuration/displayName.md | 1 + .../delete-transformation/description.md | 11 + .../delete-transformation/displayName.md | 1 + .../filterbyviewdefinition/description.md | 69 ++ .../filterbyviewdefinition/displayName.md | 1 + .../v1/operations/filterimodel/description.md | 25 + .../v1/operations/filterimodel/displayName.md | 1 + .../filtersubcategories/description.md | 26 + .../filtersubcategories/displayName.md | 1 + .../get-all-configurations/description.md | 13 + .../get-all-configurations/displayName.md | 1 + .../get-all-transformations/description.md | 13 + .../get-all-transformations/displayName.md | 1 + .../get-configuration/description.md | 13 + .../get-configuration/displayName.md | 1 + .../get-transformation/description.md | 13 + .../get-transformation/displayName.md | 1 + .../v1/operations/groupandmap/description.md | 40 ++ .../v1/operations/groupandmap/displayName.md | 1 + .../v1/operations/importimodel/description.md | 21 + .../v1/operations/importimodel/displayName.md | 1 + .../v1/operations/mergefork/description.md | 45 ++ .../v1/operations/mergefork/displayName.md | 1 + .../v1/operations/mergeimodel/description.md | 40 ++ .../v1/operations/mergeimodel/displayName.md | 1 + .../populatefederationguids/description.md | 19 + .../populatefederationguids/displayName.md | 1 + services/users/v1/description.md | 1 + .../v1/operations/get-user/description.md | 5 + .../v1/operations/get-user/displayName.md | 1 + .../get-users-by-id-list/description.md | 7 + .../get-users-by-id-list/displayName.md | 1 + .../v1/operations/get-users/description.md | 7 + .../v1/operations/get-users/displayName.md | 1 + .../users/v1/operations/me/description.md | 5 + .../users/v1/operations/me/displayName.md | 1 + services/validation/v1/description.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 11 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 7 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 15 + .../displayName.md | 1 + .../description.md | 11 + .../displayName.md | 1 + .../description.md | 15 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 17 + .../displayName.md | 1 + .../description.md | 9 + .../displayName.md | 1 + .../description.md | 11 + .../displayName.md | 1 + services/webhooks/v2/description.md | 5 + .../operations/create-webhook/description.md | 33 + .../operations/create-webhook/displayName.md | 1 + .../operations/delete-webhook/description.md | 11 + .../operations/delete-webhook/displayName.md | 1 + .../v2/operations/get-webhook/description.md | 11 + .../v2/operations/get-webhook/displayName.md | 1 + .../v2/operations/get-webhooks/description.md | 11 + .../v2/operations/get-webhooks/displayName.md | 1 + .../operations/update-webhook/description.md | 39 ++ .../operations/update-webhook/displayName.md | 1 + 1115 files changed, 8428 insertions(+) create mode 100644 apis/operations/description/Authorization.md create mode 100644 apis/operations/description/OrganizationAdministrator.md create mode 100644 apis/operations/description/ProjectsDeprecated.md create mode 100644 apis/operations/description/RateLimits.md create mode 100644 apis/operations/description/RbacPermissions.md create mode 100644 apis/operations/description/iTwinsRBACPermission.md create mode 100644 services/access-control/v2/description.md create mode 100644 services/access-control/v2/operations/add-itwin-group-members/description.md create mode 100644 services/access-control/v2/operations/add-itwin-group-members/displayName.md create mode 100644 services/access-control/v2/operations/add-itwin-owner-member/description.md create mode 100644 services/access-control/v2/operations/add-itwin-owner-member/displayName.md create mode 100644 services/access-control/v2/operations/add-itwin-user-members/description.md create mode 100644 services/access-control/v2/operations/add-itwin-user-members/displayName.md create mode 100644 services/access-control/v2/operations/create-iTwin-role/description.md create mode 100644 services/access-control/v2/operations/create-iTwin-role/displayName.md create mode 100644 services/access-control/v2/operations/create-itwin-group/description.md create mode 100644 services/access-control/v2/operations/create-itwin-group/displayName.md create mode 100644 services/access-control/v2/operations/create-itwin-job/description.md create mode 100644 services/access-control/v2/operations/create-itwin-job/displayName.md create mode 100644 services/access-control/v2/operations/delete-iTwin-role/description.md create mode 100644 services/access-control/v2/operations/delete-iTwin-role/displayName.md create mode 100644 services/access-control/v2/operations/delete-itwin-group/description.md create mode 100644 services/access-control/v2/operations/delete-itwin-group/displayName.md create mode 100644 services/access-control/v2/operations/get-all-permissions/description.md create mode 100644 services/access-control/v2/operations/get-all-permissions/displayName.md create mode 100644 services/access-control/v2/operations/get-iTwin-permissions/description.md create mode 100644 services/access-control/v2/operations/get-iTwin-permissions/displayName.md create mode 100644 services/access-control/v2/operations/get-iTwin-roles/description.md create mode 100644 services/access-control/v2/operations/get-iTwin-roles/displayName.md create mode 100644 services/access-control/v2/operations/get-itwin-group-member/description.md create mode 100644 services/access-control/v2/operations/get-itwin-group-member/displayName.md create mode 100644 services/access-control/v2/operations/get-itwin-group-members/description.md create mode 100644 services/access-control/v2/operations/get-itwin-group-members/displayName.md create mode 100644 services/access-control/v2/operations/get-itwin-group/description.md create mode 100644 services/access-control/v2/operations/get-itwin-group/displayName.md create mode 100644 services/access-control/v2/operations/get-itwin-groups/description.md create mode 100644 services/access-control/v2/operations/get-itwin-groups/displayName.md create mode 100644 services/access-control/v2/operations/get-itwin-job-actions/description.md create mode 100644 services/access-control/v2/operations/get-itwin-job-actions/displayName.md create mode 100644 services/access-control/v2/operations/get-itwin-job/description.md create mode 100644 services/access-control/v2/operations/get-itwin-job/displayName.md create mode 100644 services/access-control/v2/operations/get-itwin-member-invitations/description.md create mode 100644 services/access-control/v2/operations/get-itwin-member-invitations/displayName.md create mode 100644 services/access-control/v2/operations/get-itwin-owner-members/description.md create mode 100644 services/access-control/v2/operations/get-itwin-owner-members/displayName.md create mode 100644 services/access-control/v2/operations/get-itwin-role/description.md create mode 100644 services/access-control/v2/operations/get-itwin-role/displayName.md create mode 100644 services/access-control/v2/operations/get-itwin-user-member/description.md create mode 100644 services/access-control/v2/operations/get-itwin-user-member/displayName.md create mode 100644 services/access-control/v2/operations/get-itwin-user-members/description.md create mode 100644 services/access-control/v2/operations/get-itwin-user-members/displayName.md create mode 100644 services/access-control/v2/operations/remove-itwin-group-member/description.md create mode 100644 services/access-control/v2/operations/remove-itwin-group-member/displayName.md create mode 100644 services/access-control/v2/operations/remove-itwin-owner-member/description.md create mode 100644 services/access-control/v2/operations/remove-itwin-owner-member/displayName.md create mode 100644 services/access-control/v2/operations/remove-itwin-user-member/description.md create mode 100644 services/access-control/v2/operations/remove-itwin-user-member/displayName.md create mode 100644 services/access-control/v2/operations/update-iTwin-role/description.md create mode 100644 services/access-control/v2/operations/update-iTwin-role/displayName.md create mode 100644 services/access-control/v2/operations/update-itwin-group-member/description.md create mode 100644 services/access-control/v2/operations/update-itwin-group-member/displayName.md create mode 100644 services/access-control/v2/operations/update-itwin-group/description.md create mode 100644 services/access-control/v2/operations/update-itwin-group/displayName.md create mode 100644 services/access-control/v2/operations/update-itwin-user-member/description.md create mode 100644 services/access-control/v2/operations/update-itwin-user-member/displayName.md create mode 100644 services/carbon-calculation/v1/description.md create mode 100644 services/carbon-calculation/v1/operations/create-ec3-configuration/description.md create mode 100644 services/carbon-calculation/v1/operations/create-ec3-configuration/displayName.md create mode 100644 services/carbon-calculation/v1/operations/create-ec3-job/description.md create mode 100644 services/carbon-calculation/v1/operations/create-ec3-job/displayName.md create mode 100644 services/carbon-calculation/v1/operations/create-oneclicklca-job/description.md create mode 100644 services/carbon-calculation/v1/operations/create-oneclicklca-job/displayName.md create mode 100644 services/carbon-calculation/v1/operations/delete-ec3-configuration/description.md create mode 100644 services/carbon-calculation/v1/operations/delete-ec3-configuration/displayName.md create mode 100644 services/carbon-calculation/v1/operations/get-ec3-configuration/description.md create mode 100644 services/carbon-calculation/v1/operations/get-ec3-configuration/displayName.md create mode 100644 services/carbon-calculation/v1/operations/get-ec3-configurations/description.md create mode 100644 services/carbon-calculation/v1/operations/get-ec3-configurations/displayName.md create mode 100644 services/carbon-calculation/v1/operations/get-ec3-job-status/description.md create mode 100644 services/carbon-calculation/v1/operations/get-ec3-job-status/displayName.md create mode 100644 services/carbon-calculation/v1/operations/get-oneclicklca-job-status/description.md create mode 100644 services/carbon-calculation/v1/operations/get-oneclicklca-job-status/displayName.md create mode 100644 services/carbon-calculation/v1/operations/update-ec3-configuration/description.md create mode 100644 services/carbon-calculation/v1/operations/update-ec3-configuration/displayName.md create mode 100644 services/changed-elements/v2/description.md create mode 100644 services/changed-elements/v2/operations/create-comparison-job/description.md create mode 100644 services/changed-elements/v2/operations/create-comparison-job/displayName.md create mode 100644 services/changed-elements/v2/operations/delete-comparison-job/description.md create mode 100644 services/changed-elements/v2/operations/delete-comparison-job/displayName.md create mode 100644 services/changed-elements/v2/operations/get-comparison-job/description.md create mode 100644 services/changed-elements/v2/operations/get-comparison-job/displayName.md create mode 100644 services/clash-detection/v2/description.md create mode 100644 services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/description.md create mode 100644 services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/displayName.md create mode 100644 services/clash-detection/v2/operations/cancel-clashdetection-run/description.md create mode 100644 services/clash-detection/v2/operations/cancel-clashdetection-run/displayName.md create mode 100644 services/clash-detection/v2/operations/create-clashdetection-suppression-rule/description.md create mode 100644 services/clash-detection/v2/operations/create-clashdetection-suppression-rule/displayName.md create mode 100644 services/clash-detection/v2/operations/create-clashdetection-tests/description.md create mode 100644 services/clash-detection/v2/operations/create-clashdetection-tests/displayName.md create mode 100644 services/clash-detection/v2/operations/delete-clashdetection-run/description.md create mode 100644 services/clash-detection/v2/operations/delete-clashdetection-run/displayName.md create mode 100644 services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/description.md create mode 100644 services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/displayName.md create mode 100644 services/clash-detection/v2/operations/delete-clashdetection-test/description.md create mode 100644 services/clash-detection/v2/operations/delete-clashdetection-test/displayName.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/description.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/displayName.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-result/description.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-result/displayName.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-results/description.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-results/displayName.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-suppression-rule/description.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-suppression-rule/displayName.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-suppression-rules/description.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-suppression-rules/displayName.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-test/description.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-test/displayName.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-tests/description.md create mode 100644 services/clash-detection/v2/operations/get-clashdetection-tests/displayName.md create mode 100644 services/clash-detection/v2/operations/get-suppression-rule-templates/description.md create mode 100644 services/clash-detection/v2/operations/get-suppression-rule-templates/displayName.md create mode 100644 services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/description.md create mode 100644 services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/displayName.md create mode 100644 services/clash-detection/v2/operations/run-clashdetection-test/description.md create mode 100644 services/clash-detection/v2/operations/run-clashdetection-test/displayName.md create mode 100644 services/clash-detection/v2/operations/update-clashdetection-suppression-rule/description.md create mode 100644 services/clash-detection/v2/operations/update-clashdetection-suppression-rule/displayName.md create mode 100644 services/clash-detection/v2/operations/update-clashdetection-test/description.md create mode 100644 services/clash-detection/v2/operations/update-clashdetection-test/displayName.md create mode 100644 services/contextcapture/v1/description.md create mode 100644 services/contextcapture/v1/operations/jobs-create/description.md create mode 100644 services/contextcapture/v1/operations/jobs-create/displayName.md create mode 100644 services/contextcapture/v1/operations/jobs-delete/description.md create mode 100644 services/contextcapture/v1/operations/jobs-delete/displayName.md create mode 100644 services/contextcapture/v1/operations/jobs-get/description.md create mode 100644 services/contextcapture/v1/operations/jobs-get/displayName.md create mode 100644 services/contextcapture/v1/operations/jobs-patch/description.md create mode 100644 services/contextcapture/v1/operations/jobs-patch/displayName.md create mode 100644 services/contextcapture/v1/operations/jobs-progress/description.md create mode 100644 services/contextcapture/v1/operations/jobs-progress/displayName.md create mode 100644 services/contextcapture/v1/operations/limits-engines/description.md create mode 100644 services/contextcapture/v1/operations/limits-engines/displayName.md create mode 100644 services/contextcapture/v1/operations/workspaces-create/description.md create mode 100644 services/contextcapture/v1/operations/workspaces-create/displayName.md create mode 100644 services/contextcapture/v1/operations/workspaces-delete/description.md create mode 100644 services/contextcapture/v1/operations/workspaces-delete/displayName.md create mode 100644 services/contextcapture/v1/operations/workspaces-get/description.md create mode 100644 services/contextcapture/v1/operations/workspaces-get/displayName.md create mode 100644 services/echo/v2/description.md create mode 100644 services/echo/v2/operations/context-nested-parameter/description.md create mode 100644 services/echo/v2/operations/context-nested-parameter/displayName.md create mode 100644 services/echo/v2/operations/context-parameter/description.md create mode 100644 services/echo/v2/operations/context-parameter/displayName.md create mode 100644 services/echo/v2/operations/context/description.md create mode 100644 services/echo/v2/operations/context/displayName.md create mode 100644 services/export/v1/description.md create mode 100644 services/export/v1/operations/create-export-connection-run/description.md create mode 100644 services/export/v1/operations/create-export-connection-run/displayName.md create mode 100644 services/export/v1/operations/create-export-connection/description.md create mode 100644 services/export/v1/operations/create-export-connection/displayName.md create mode 100644 services/export/v1/operations/delete-export-connection/description.md create mode 100644 services/export/v1/operations/delete-export-connection/displayName.md create mode 100644 services/export/v1/operations/get-authorizationinformation/description.md create mode 100644 services/export/v1/operations/get-authorizationinformation/displayName.md create mode 100644 services/export/v1/operations/get-export-connection-run/description.md create mode 100644 services/export/v1/operations/get-export-connection-run/displayName.md create mode 100644 services/export/v1/operations/get-export-connection-runs/description.md create mode 100644 services/export/v1/operations/get-export-connection-runs/displayName.md create mode 100644 services/export/v1/operations/get-export-connection/description.md create mode 100644 services/export/v1/operations/get-export-connection/displayName.md create mode 100644 services/export/v1/operations/get-export-connections/description.md create mode 100644 services/export/v1/operations/get-export-connections/displayName.md create mode 100644 services/extensions/v1/description.md create mode 100644 services/extensions/v1/operations/create-extension-version/description.md create mode 100644 services/extensions/v1/operations/create-extension-version/displayName.md create mode 100644 services/extensions/v1/operations/create-private-extension/description.md create mode 100644 services/extensions/v1/operations/create-private-extension/displayName.md create mode 100644 services/extensions/v1/operations/create-public-itwin-studio-app/description.md create mode 100644 services/extensions/v1/operations/create-public-itwin-studio-app/displayName.md create mode 100644 services/extensions/v1/operations/delete-extension/description.md create mode 100644 services/extensions/v1/operations/delete-extension/displayName.md create mode 100644 services/extensions/v1/operations/get-extension-version/description.md create mode 100644 services/extensions/v1/operations/get-extension-version/displayName.md create mode 100644 services/extensions/v1/operations/get-extension-versions/description.md create mode 100644 services/extensions/v1/operations/get-extension-versions/displayName.md create mode 100644 services/extensions/v1/operations/get-extensions/description.md create mode 100644 services/extensions/v1/operations/get-extensions/displayName.md create mode 100644 services/extensions/v1/operations/get-latest-extension-version/description.md create mode 100644 services/extensions/v1/operations/get-latest-extension-version/displayName.md create mode 100644 services/extensions/v1/operations/update-extension/description.md create mode 100644 services/extensions/v1/operations/update-extension/displayName.md create mode 100644 services/forms/v1/description.md create mode 100644 services/forms/v1/operations/add-attachment-to-form/description.md create mode 100644 services/forms/v1/operations/add-attachment-to-form/displayName.md create mode 100644 services/forms/v1/operations/add-comment-to-form/description.md create mode 100644 services/forms/v1/operations/add-comment-to-form/displayName.md create mode 100644 services/forms/v1/operations/create-form-data/description.md create mode 100644 services/forms/v1/operations/create-form-data/displayName.md create mode 100644 services/forms/v1/operations/delete-attachment/description.md create mode 100644 services/forms/v1/operations/delete-attachment/displayName.md create mode 100644 services/forms/v1/operations/delete-comment/description.md create mode 100644 services/forms/v1/operations/delete-comment/displayName.md create mode 100644 services/forms/v1/operations/delete-form-data/description.md create mode 100644 services/forms/v1/operations/delete-form-data/displayName.md create mode 100644 services/forms/v1/operations/download-form-as-file/description.md create mode 100644 services/forms/v1/operations/download-form-as-file/displayName.md create mode 100644 services/forms/v1/operations/export-form-to-storage/description.md create mode 100644 services/forms/v1/operations/export-form-to-storage/displayName.md create mode 100644 services/forms/v1/operations/get-attachment-file-by-id/description.md create mode 100644 services/forms/v1/operations/get-attachment-file-by-id/displayName.md create mode 100644 services/forms/v1/operations/get-audit-trail-for-form-data/description.md create mode 100644 services/forms/v1/operations/get-audit-trail-for-form-data/displayName.md create mode 100644 services/forms/v1/operations/get-form-data-attachments/description.md create mode 100644 services/forms/v1/operations/get-form-data-attachments/displayName.md create mode 100644 services/forms/v1/operations/get-form-data-comments/description.md create mode 100644 services/forms/v1/operations/get-form-data-comments/displayName.md create mode 100644 services/forms/v1/operations/get-form-data-details/description.md create mode 100644 services/forms/v1/operations/get-form-data-details/displayName.md create mode 100644 services/forms/v1/operations/get-form-definition-by-id/description.md create mode 100644 services/forms/v1/operations/get-form-definition-by-id/displayName.md create mode 100644 services/forms/v1/operations/get-list-group/description.md create mode 100644 services/forms/v1/operations/get-list-group/displayName.md create mode 100644 services/forms/v1/operations/get-project-form-data/description.md create mode 100644 services/forms/v1/operations/get-project-form-data/displayName.md create mode 100644 services/forms/v1/operations/get-project-form-definitions/description.md create mode 100644 services/forms/v1/operations/get-project-form-definitions/displayName.md create mode 100644 services/forms/v1/operations/get-static-image/description.md create mode 100644 services/forms/v1/operations/get-static-image/displayName.md create mode 100644 services/forms/v1/operations/get-workflow/description.md create mode 100644 services/forms/v1/operations/get-workflow/displayName.md create mode 100644 services/forms/v1/operations/update-form-data/description.md create mode 100644 services/forms/v1/operations/update-form-data/displayName.md create mode 100644 services/forms/v1/operations/upload-attachment-file/description.md create mode 100644 services/forms/v1/operations/upload-attachment-file/displayName.md create mode 100644 services/grouping-and-mapping/v1/description.md create mode 100644 services/grouping-and-mapping/v1/operations/create-group/description.md create mode 100644 services/grouping-and-mapping/v1/operations/create-group/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/create-mapping/description.md create mode 100644 services/grouping-and-mapping/v1/operations/create-mapping/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/create-property/description.md create mode 100644 services/grouping-and-mapping/v1/operations/create-property/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/delete-group/description.md create mode 100644 services/grouping-and-mapping/v1/operations/delete-group/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/delete-mapping/description.md create mode 100644 services/grouping-and-mapping/v1/operations/delete-mapping/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/delete-property/description.md create mode 100644 services/grouping-and-mapping/v1/operations/delete-property/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-audittrail-imodel/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-audittrail-imodel/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-cdm-partition/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-cdm-partition/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-cdm/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-cdm/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-extraction-logs/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-extraction-logs/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-extraction-status/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-extraction-status/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-group/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-group/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-groups/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-groups/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-imodel-extractions/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-imodel-extractions/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-mapping-extractions/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-mapping-extractions/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-mapping/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-mapping/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-mappings/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-mappings/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-properties/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-properties/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/get-property/description.md create mode 100644 services/grouping-and-mapping/v1/operations/get-property/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/run-extraction/description.md create mode 100644 services/grouping-and-mapping/v1/operations/run-extraction/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/update-group/description.md create mode 100644 services/grouping-and-mapping/v1/operations/update-group/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/update-mapping/description.md create mode 100644 services/grouping-and-mapping/v1/operations/update-mapping/displayName.md create mode 100644 services/grouping-and-mapping/v1/operations/update-property/description.md create mode 100644 services/grouping-and-mapping/v1/operations/update-property/displayName.md create mode 100644 services/imodel-rpc/v1/operations/rpc-version-get/description.md create mode 100644 services/imodel-rpc/v1/operations/rpc-version-get/displayName.md create mode 100644 services/imodel-rpc/v1/operations/rpc-version/description.md create mode 100644 services/imodel-rpc/v1/operations/rpc-version/displayName.md create mode 100644 services/imodels-odata/v1/description.md create mode 100644 services/imodels-odata/v1/operations/mapping-odata-entity/description.md create mode 100644 services/imodels-odata/v1/operations/mapping-odata-entity/displayName.md create mode 100644 services/imodels-odata/v1/operations/mapping-odata-metadata/description.md create mode 100644 services/imodels-odata/v1/operations/mapping-odata-metadata/displayName.md create mode 100644 services/imodels-odata/v1/operations/mapping-odata/description.md create mode 100644 services/imodels-odata/v1/operations/mapping-odata/displayName.md create mode 100644 services/imodels/v2/description.md create mode 100644 services/imodels/v2/operations/acquire-imodel-briefcase/description.md create mode 100644 services/imodels/v2/operations/acquire-imodel-briefcase/displayName.md create mode 100644 services/imodels/v2/operations/clone-imodel/description.md create mode 100644 services/imodels/v2/operations/clone-imodel/displayName.md create mode 100644 services/imodels/v2/operations/complete-imodel-baseline-file-upload/description.md create mode 100644 services/imodels/v2/operations/complete-imodel-baseline-file-upload/displayName.md create mode 100644 services/imodels/v2/operations/create-imodel-changeset-extended-data/description.md create mode 100644 services/imodels/v2/operations/create-imodel-changeset-extended-data/displayName.md create mode 100644 services/imodels/v2/operations/create-imodel-changeset-group/description.md create mode 100644 services/imodels/v2/operations/create-imodel-changeset-group/displayName.md create mode 100644 services/imodels/v2/operations/create-imodel-changeset/description.md create mode 100644 services/imodels/v2/operations/create-imodel-changeset/displayName.md create mode 100644 services/imodels/v2/operations/create-imodel-named-version/description.md create mode 100644 services/imodels/v2/operations/create-imodel-named-version/displayName.md create mode 100644 services/imodels/v2/operations/create-imodel-share/description.md create mode 100644 services/imodels/v2/operations/create-imodel-share/displayName.md create mode 100644 services/imodels/v2/operations/create-imodel/description.md create mode 100644 services/imodels/v2/operations/create-imodel/displayName.md create mode 100644 services/imodels/v2/operations/delete-imodel/description.md create mode 100644 services/imodels/v2/operations/delete-imodel/displayName.md create mode 100644 services/imodels/v2/operations/fork-imodel/description.md create mode 100644 services/imodels/v2/operations/fork-imodel/displayName.md create mode 100644 services/imodels/v2/operations/get-briefcase-checkpoint/description.md create mode 100644 services/imodels/v2/operations/get-briefcase-checkpoint/displayName.md create mode 100644 services/imodels/v2/operations/get-changeset-checkpoint/description.md create mode 100644 services/imodels/v2/operations/get-changeset-checkpoint/displayName.md create mode 100644 services/imodels/v2/operations/get-create-imodel-operation-details/description.md create mode 100644 services/imodels/v2/operations/get-create-imodel-operation-details/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-baseline-file-details/description.md create mode 100644 services/imodels/v2/operations/get-imodel-baseline-file-details/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-briefcase-details/description.md create mode 100644 services/imodels/v2/operations/get-imodel-briefcase-details/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-briefcases/description.md create mode 100644 services/imodels/v2/operations/get-imodel-briefcases/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-changeset-details/description.md create mode 100644 services/imodels/v2/operations/get-imodel-changeset-details/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-changeset-extended-data-details/description.md create mode 100644 services/imodels/v2/operations/get-imodel-changeset-extended-data-details/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-changeset-group-details/description.md create mode 100644 services/imodels/v2/operations/get-imodel-changeset-group-details/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-changeset-groups/description.md create mode 100644 services/imodels/v2/operations/get-imodel-changeset-groups/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-changesets-extended-data/description.md create mode 100644 services/imodels/v2/operations/get-imodel-changesets-extended-data/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-changesets/description.md create mode 100644 services/imodels/v2/operations/get-imodel-changesets/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-details/description.md create mode 100644 services/imodels/v2/operations/get-imodel-details/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-locks/description.md create mode 100644 services/imodels/v2/operations/get-imodel-locks/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-named-version-details/description.md create mode 100644 services/imodels/v2/operations/get-imodel-named-version-details/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-named-versions/description.md create mode 100644 services/imodels/v2/operations/get-imodel-named-versions/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-permissions/description.md create mode 100644 services/imodels/v2/operations/get-imodel-permissions/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-role-permissions/description.md create mode 100644 services/imodels/v2/operations/get-imodel-role-permissions/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-share/description.md create mode 100644 services/imodels/v2/operations/get-imodel-share/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-shares/description.md create mode 100644 services/imodels/v2/operations/get-imodel-shares/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-thumbnail/description.md create mode 100644 services/imodels/v2/operations/get-imodel-thumbnail/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-user-details/description.md create mode 100644 services/imodels/v2/operations/get-imodel-user-details/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-user-permissions/description.md create mode 100644 services/imodels/v2/operations/get-imodel-user-permissions/displayName.md create mode 100644 services/imodels/v2/operations/get-imodel-users/description.md create mode 100644 services/imodels/v2/operations/get-imodel-users/displayName.md create mode 100644 services/imodels/v2/operations/get-itwin-imodels/description.md create mode 100644 services/imodels/v2/operations/get-itwin-imodels/displayName.md create mode 100644 services/imodels/v2/operations/get-named-version-checkpoint/description.md create mode 100644 services/imodels/v2/operations/get-named-version-checkpoint/displayName.md create mode 100644 services/imodels/v2/operations/release-imodel-briefcase/description.md create mode 100644 services/imodels/v2/operations/release-imodel-briefcase/displayName.md create mode 100644 services/imodels/v2/operations/revoke-imodel-share/description.md create mode 100644 services/imodels/v2/operations/revoke-imodel-share/displayName.md create mode 100644 services/imodels/v2/operations/update-imodel-changeset-group/description.md create mode 100644 services/imodels/v2/operations/update-imodel-changeset-group/displayName.md create mode 100644 services/imodels/v2/operations/update-imodel-changeset/description.md create mode 100644 services/imodels/v2/operations/update-imodel-changeset/displayName.md create mode 100644 services/imodels/v2/operations/update-imodel-locks/description.md create mode 100644 services/imodels/v2/operations/update-imodel-locks/displayName.md create mode 100644 services/imodels/v2/operations/update-imodel-named-version/description.md create mode 100644 services/imodels/v2/operations/update-imodel-named-version/displayName.md create mode 100644 services/imodels/v2/operations/update-imodel-role-permissions/description.md create mode 100644 services/imodels/v2/operations/update-imodel-role-permissions/displayName.md create mode 100644 services/imodels/v2/operations/update-imodel-share/description.md create mode 100644 services/imodels/v2/operations/update-imodel-share/displayName.md create mode 100644 services/imodels/v2/operations/update-imodel-user-permissions/description.md create mode 100644 services/imodels/v2/operations/update-imodel-user-permissions/displayName.md create mode 100644 services/imodels/v2/operations/update-imodel/description.md create mode 100644 services/imodels/v2/operations/update-imodel/displayName.md create mode 100644 services/imodels/v2/operations/upload-imodel-thumbnail/description.md create mode 100644 services/imodels/v2/operations/upload-imodel-thumbnail/displayName.md create mode 100644 services/issues/v1/description.md create mode 100644 services/issues/v1/operations/add-attachment-to-issue/description.md create mode 100644 services/issues/v1/operations/add-attachment-to-issue/displayName.md create mode 100644 services/issues/v1/operations/add-comment-to-issue/description.md create mode 100644 services/issues/v1/operations/add-comment-to-issue/displayName.md create mode 100644 services/issues/v1/operations/create-issue/description.md create mode 100644 services/issues/v1/operations/create-issue/displayName.md create mode 100644 services/issues/v1/operations/delete-attachment/description.md create mode 100644 services/issues/v1/operations/delete-attachment/displayName.md create mode 100644 services/issues/v1/operations/delete-comment/description.md create mode 100644 services/issues/v1/operations/delete-comment/displayName.md create mode 100644 services/issues/v1/operations/delete-issue/description.md create mode 100644 services/issues/v1/operations/delete-issue/displayName.md create mode 100644 services/issues/v1/operations/download-issue-as-file/description.md create mode 100644 services/issues/v1/operations/download-issue-as-file/displayName.md create mode 100644 services/issues/v1/operations/export-issues-to-storage/description.md create mode 100644 services/issues/v1/operations/export-issues-to-storage/displayName.md create mode 100644 services/issues/v1/operations/get-attachment-by-id/description.md create mode 100644 services/issues/v1/operations/get-attachment-by-id/displayName.md create mode 100644 services/issues/v1/operations/get-form-definition-by-id/description.md create mode 100644 services/issues/v1/operations/get-form-definition-by-id/displayName.md create mode 100644 services/issues/v1/operations/get-issue-attachments/description.md create mode 100644 services/issues/v1/operations/get-issue-attachments/displayName.md create mode 100644 services/issues/v1/operations/get-issue-audit-trail/description.md create mode 100644 services/issues/v1/operations/get-issue-audit-trail/displayName.md create mode 100644 services/issues/v1/operations/get-issue-comments/description.md create mode 100644 services/issues/v1/operations/get-issue-comments/displayName.md create mode 100644 services/issues/v1/operations/get-issue-details/description.md create mode 100644 services/issues/v1/operations/get-issue-details/displayName.md create mode 100644 services/issues/v1/operations/get-list-group/description.md create mode 100644 services/issues/v1/operations/get-list-group/displayName.md create mode 100644 services/issues/v1/operations/get-project-form-definitions/description.md create mode 100644 services/issues/v1/operations/get-project-form-definitions/displayName.md create mode 100644 services/issues/v1/operations/get-project-issues/description.md create mode 100644 services/issues/v1/operations/get-project-issues/displayName.md create mode 100644 services/issues/v1/operations/get-static-image/description.md create mode 100644 services/issues/v1/operations/get-static-image/displayName.md create mode 100644 services/issues/v1/operations/get-workflow/description.md create mode 100644 services/issues/v1/operations/get-workflow/displayName.md create mode 100644 services/issues/v1/operations/modify-issue/description.md create mode 100644 services/issues/v1/operations/modify-issue/displayName.md create mode 100644 services/issues/v1/operations/upload-attachment-file/description.md create mode 100644 services/issues/v1/operations/upload-attachment-file/displayName.md create mode 100644 services/itwin-entities/v1/description.md create mode 100644 services/itwin-entities/v1/operations/create-entity/description.md create mode 100644 services/itwin-entities/v1/operations/create-entity/displayName.md create mode 100644 services/itwin-entities/v1/operations/create-hierarchy-nodes/description.md create mode 100644 services/itwin-entities/v1/operations/create-hierarchy-nodes/displayName.md create mode 100644 services/itwin-entities/v1/operations/create-hierarchy/description.md create mode 100644 services/itwin-entities/v1/operations/create-hierarchy/displayName.md create mode 100644 services/itwin-entities/v1/operations/create-link/description.md create mode 100644 services/itwin-entities/v1/operations/create-link/displayName.md create mode 100644 services/itwin-entities/v1/operations/delete-entity/description.md create mode 100644 services/itwin-entities/v1/operations/delete-entity/displayName.md create mode 100644 services/itwin-entities/v1/operations/delete-hierarchy-node/description.md create mode 100644 services/itwin-entities/v1/operations/delete-hierarchy-node/displayName.md create mode 100644 services/itwin-entities/v1/operations/delete-hierarchy/description.md create mode 100644 services/itwin-entities/v1/operations/delete-hierarchy/displayName.md create mode 100644 services/itwin-entities/v1/operations/delete-link/description.md create mode 100644 services/itwin-entities/v1/operations/delete-link/displayName.md create mode 100644 services/itwin-entities/v1/operations/get-entities/description.md create mode 100644 services/itwin-entities/v1/operations/get-entities/displayName.md create mode 100644 services/itwin-entities/v1/operations/get-entity/description.md create mode 100644 services/itwin-entities/v1/operations/get-entity/displayName.md create mode 100644 services/itwin-entities/v1/operations/get-hierarchies/description.md create mode 100644 services/itwin-entities/v1/operations/get-hierarchies/displayName.md create mode 100644 services/itwin-entities/v1/operations/get-hierarchy-nodes/description.md create mode 100644 services/itwin-entities/v1/operations/get-hierarchy-nodes/displayName.md create mode 100644 services/itwin-entities/v1/operations/get-hierarchy/description.md create mode 100644 services/itwin-entities/v1/operations/get-hierarchy/displayName.md create mode 100644 services/itwin-entities/v1/operations/get-links/description.md create mode 100644 services/itwin-entities/v1/operations/get-links/displayName.md create mode 100644 services/itwin-entities/v1/operations/update-entity/description.md create mode 100644 services/itwin-entities/v1/operations/update-entity/displayName.md create mode 100644 services/itwin-entities/v1/operations/update-hierarchy/description.md create mode 100644 services/itwin-entities/v1/operations/update-hierarchy/displayName.md create mode 100644 services/itwin-search/v1/description.md create mode 100644 services/itwin-search/v1/operations/discover/description.md create mode 100644 services/itwin-search/v1/operations/discover/displayName.md create mode 100644 services/itwin-search/v1/operations/post-search/description.md create mode 100644 services/itwin-search/v1/operations/post-search/displayName.md create mode 100644 services/itwins/v1/description.md create mode 100644 services/itwins/v1/operations/add-itwin-to-my-favorites/description.md create mode 100644 services/itwins/v1/operations/add-itwin-to-my-favorites/displayName.md create mode 100644 services/itwins/v1/operations/add-itwin-to-my-recents/description.md create mode 100644 services/itwins/v1/operations/add-itwin-to-my-recents/displayName.md create mode 100644 services/itwins/v1/operations/create-itwin/description.md create mode 100644 services/itwins/v1/operations/create-itwin/displayName.md create mode 100644 services/itwins/v1/operations/create-repository/description.md create mode 100644 services/itwins/v1/operations/create-repository/displayName.md create mode 100644 services/itwins/v1/operations/delete-itwin-image/description.md create mode 100644 services/itwins/v1/operations/delete-itwin-image/displayName.md create mode 100644 services/itwins/v1/operations/delete-itwin/description.md create mode 100644 services/itwins/v1/operations/delete-itwin/displayName.md create mode 100644 services/itwins/v1/operations/delete-repository/description.md create mode 100644 services/itwins/v1/operations/delete-repository/displayName.md create mode 100644 services/itwins/v1/operations/get-itwin-account/description.md create mode 100644 services/itwins/v1/operations/get-itwin-account/displayName.md create mode 100644 services/itwins/v1/operations/get-itwin-image/description.md create mode 100644 services/itwins/v1/operations/get-itwin-image/displayName.md create mode 100644 services/itwins/v1/operations/get-itwin/description.md create mode 100644 services/itwins/v1/operations/get-itwin/displayName.md create mode 100644 services/itwins/v1/operations/get-my-favorite-itwins/description.md create mode 100644 services/itwins/v1/operations/get-my-favorite-itwins/displayName.md create mode 100644 services/itwins/v1/operations/get-my-itwins/description.md create mode 100644 services/itwins/v1/operations/get-my-itwins/displayName.md create mode 100644 services/itwins/v1/operations/get-my-primary-account/description.md create mode 100644 services/itwins/v1/operations/get-my-primary-account/displayName.md create mode 100644 services/itwins/v1/operations/get-my-recently-used-itwins/description.md create mode 100644 services/itwins/v1/operations/get-my-recently-used-itwins/displayName.md create mode 100644 services/itwins/v1/operations/get-repositories-by-itwin-id/description.md create mode 100644 services/itwins/v1/operations/get-repositories-by-itwin-id/displayName.md create mode 100644 services/itwins/v1/operations/remove-itwin-from-my-favorites/description.md create mode 100644 services/itwins/v1/operations/remove-itwin-from-my-favorites/displayName.md create mode 100644 services/itwins/v1/operations/update-itwin/description.md create mode 100644 services/itwins/v1/operations/update-itwin/displayName.md create mode 100644 services/itwins/v1/operations/upload-itwin-image/description.md create mode 100644 services/itwins/v1/operations/upload-itwin-image/displayName.md create mode 100644 services/library/v1/description.md create mode 100644 services/library/v1/operations/create-application/description.md create mode 100644 services/library/v1/operations/create-application/displayName.md create mode 100644 services/library/v1/operations/create-catalog-document/description.md create mode 100644 services/library/v1/operations/create-catalog-document/displayName.md create mode 100644 services/library/v1/operations/create-catalog-weblink/description.md create mode 100644 services/library/v1/operations/create-catalog-weblink/displayName.md create mode 100644 services/library/v1/operations/create-catalog/description.md create mode 100644 services/library/v1/operations/create-catalog/displayName.md create mode 100644 services/library/v1/operations/create-category/description.md create mode 100644 services/library/v1/operations/create-category/displayName.md create mode 100644 services/library/v1/operations/create-component-document/description.md create mode 100644 services/library/v1/operations/create-component-document/displayName.md create mode 100644 services/library/v1/operations/create-component-variation/description.md create mode 100644 services/library/v1/operations/create-component-variation/displayName.md create mode 100644 services/library/v1/operations/create-component-weblink/description.md create mode 100644 services/library/v1/operations/create-component-weblink/displayName.md create mode 100644 services/library/v1/operations/create-component/description.md create mode 100644 services/library/v1/operations/create-component/displayName.md create mode 100644 services/library/v1/operations/create-manufacturer/description.md create mode 100644 services/library/v1/operations/create-manufacturer/displayName.md create mode 100644 services/library/v1/operations/delete-application/description.md create mode 100644 services/library/v1/operations/delete-application/displayName.md create mode 100644 services/library/v1/operations/delete-catalog-document/description.md create mode 100644 services/library/v1/operations/delete-catalog-document/displayName.md create mode 100644 services/library/v1/operations/delete-catalog-weblink/description.md create mode 100644 services/library/v1/operations/delete-catalog-weblink/displayName.md create mode 100644 services/library/v1/operations/delete-catalog/description.md create mode 100644 services/library/v1/operations/delete-catalog/displayName.md create mode 100644 services/library/v1/operations/delete-category/description.md create mode 100644 services/library/v1/operations/delete-category/displayName.md create mode 100644 services/library/v1/operations/delete-component-document/description.md create mode 100644 services/library/v1/operations/delete-component-document/displayName.md create mode 100644 services/library/v1/operations/delete-component-variation/description.md create mode 100644 services/library/v1/operations/delete-component-variation/displayName.md create mode 100644 services/library/v1/operations/delete-component-weblink/description.md create mode 100644 services/library/v1/operations/delete-component-weblink/displayName.md create mode 100644 services/library/v1/operations/delete-component/description.md create mode 100644 services/library/v1/operations/delete-component/displayName.md create mode 100644 services/library/v1/operations/delete-manufacturer/description.md create mode 100644 services/library/v1/operations/delete-manufacturer/displayName.md create mode 100644 services/library/v1/operations/download-analytics/description.md create mode 100644 services/library/v1/operations/download-analytics/displayName.md create mode 100644 services/library/v1/operations/get-application/description.md create mode 100644 services/library/v1/operations/get-application/displayName.md create mode 100644 services/library/v1/operations/get-applications/description.md create mode 100644 services/library/v1/operations/get-applications/displayName.md create mode 100644 services/library/v1/operations/get-brand-component-documents/description.md create mode 100644 services/library/v1/operations/get-brand-component-documents/displayName.md create mode 100644 services/library/v1/operations/get-brand-component-variations/description.md create mode 100644 services/library/v1/operations/get-brand-component-variations/displayName.md create mode 100644 services/library/v1/operations/get-brand-component-weblinks/description.md create mode 100644 services/library/v1/operations/get-brand-component-weblinks/displayName.md create mode 100644 services/library/v1/operations/get-brand-components/description.md create mode 100644 services/library/v1/operations/get-brand-components/displayName.md create mode 100644 services/library/v1/operations/get-brand/description.md create mode 100644 services/library/v1/operations/get-brand/displayName.md create mode 100644 services/library/v1/operations/get-brands/description.md create mode 100644 services/library/v1/operations/get-brands/displayName.md create mode 100644 services/library/v1/operations/get-catalog-document/description.md create mode 100644 services/library/v1/operations/get-catalog-document/displayName.md create mode 100644 services/library/v1/operations/get-catalog-documents/description.md create mode 100644 services/library/v1/operations/get-catalog-documents/displayName.md create mode 100644 services/library/v1/operations/get-catalog-weblink/description.md create mode 100644 services/library/v1/operations/get-catalog-weblink/displayName.md create mode 100644 services/library/v1/operations/get-catalog-weblinks/description.md create mode 100644 services/library/v1/operations/get-catalog-weblinks/displayName.md create mode 100644 services/library/v1/operations/get-catalog/description.md create mode 100644 services/library/v1/operations/get-catalog/displayName.md create mode 100644 services/library/v1/operations/get-catalogs/description.md create mode 100644 services/library/v1/operations/get-catalogs/displayName.md create mode 100644 services/library/v1/operations/get-categories/description.md create mode 100644 services/library/v1/operations/get-categories/displayName.md create mode 100644 services/library/v1/operations/get-category/description.md create mode 100644 services/library/v1/operations/get-category/displayName.md create mode 100644 services/library/v1/operations/get-component-document/description.md create mode 100644 services/library/v1/operations/get-component-document/displayName.md create mode 100644 services/library/v1/operations/get-component-documents/description.md create mode 100644 services/library/v1/operations/get-component-documents/displayName.md create mode 100644 services/library/v1/operations/get-component-variation/description.md create mode 100644 services/library/v1/operations/get-component-variation/displayName.md create mode 100644 services/library/v1/operations/get-component-variations/description.md create mode 100644 services/library/v1/operations/get-component-variations/displayName.md create mode 100644 services/library/v1/operations/get-component-weblink/description.md create mode 100644 services/library/v1/operations/get-component-weblink/displayName.md create mode 100644 services/library/v1/operations/get-component-weblinks/description.md create mode 100644 services/library/v1/operations/get-component-weblinks/displayName.md create mode 100644 services/library/v1/operations/get-component/description.md create mode 100644 services/library/v1/operations/get-component/displayName.md create mode 100644 services/library/v1/operations/get-components/description.md create mode 100644 services/library/v1/operations/get-components/displayName.md create mode 100644 services/library/v1/operations/get-job/description.md create mode 100644 services/library/v1/operations/get-job/displayName.md create mode 100644 services/library/v1/operations/get-manufacturer/description.md create mode 100644 services/library/v1/operations/get-manufacturer/displayName.md create mode 100644 services/library/v1/operations/get-manufacturers/description.md create mode 100644 services/library/v1/operations/get-manufacturers/displayName.md create mode 100644 services/library/v1/operations/update-application/description.md create mode 100644 services/library/v1/operations/update-application/displayName.md create mode 100644 services/library/v1/operations/update-catalog-document/description.md create mode 100644 services/library/v1/operations/update-catalog-document/displayName.md create mode 100644 services/library/v1/operations/update-catalog-weblink/description.md create mode 100644 services/library/v1/operations/update-catalog-weblink/displayName.md create mode 100644 services/library/v1/operations/update-catalog/description.md create mode 100644 services/library/v1/operations/update-catalog/displayName.md create mode 100644 services/library/v1/operations/update-category/description.md create mode 100644 services/library/v1/operations/update-category/displayName.md create mode 100644 services/library/v1/operations/update-component-document/description.md create mode 100644 services/library/v1/operations/update-component-document/displayName.md create mode 100644 services/library/v1/operations/update-component-variation/description.md create mode 100644 services/library/v1/operations/update-component-variation/displayName.md create mode 100644 services/library/v1/operations/update-component-weblink/description.md create mode 100644 services/library/v1/operations/update-component-weblink/displayName.md create mode 100644 services/library/v1/operations/update-component/description.md create mode 100644 services/library/v1/operations/update-component/displayName.md create mode 100644 services/library/v1/operations/update-manufacturer/description.md create mode 100644 services/library/v1/operations/update-manufacturer/displayName.md create mode 100644 services/library/v1/operations/upload-component/description.md create mode 100644 services/library/v1/operations/upload-component/displayName.md create mode 100644 services/mesh-export/v1/description.md create mode 100644 services/mesh-export/v1/operations/delete-export/description.md create mode 100644 services/mesh-export/v1/operations/delete-export/displayName.md create mode 100644 services/mesh-export/v1/operations/get-export/description.md create mode 100644 services/mesh-export/v1/operations/get-export/displayName.md create mode 100644 services/mesh-export/v1/operations/get-exports/description.md create mode 100644 services/mesh-export/v1/operations/get-exports/displayName.md create mode 100644 services/mesh-export/v1/operations/start-export/description.md create mode 100644 services/mesh-export/v1/operations/start-export/displayName.md create mode 100644 services/named-groups/v1/operations/create-group/description.md create mode 100644 services/named-groups/v1/operations/create-group/displayName.md create mode 100644 services/named-groups/v1/operations/delete-group/description.md create mode 100644 services/named-groups/v1/operations/delete-group/displayName.md create mode 100644 services/named-groups/v1/operations/get-group/description.md create mode 100644 services/named-groups/v1/operations/get-group/displayName.md create mode 100644 services/named-groups/v1/operations/get-itwin-groups/description.md create mode 100644 services/named-groups/v1/operations/get-itwin-groups/displayName.md create mode 100644 services/named-groups/v1/operations/update-group/description.md create mode 100644 services/named-groups/v1/operations/update-group/displayName.md create mode 100644 services/pnid-to-itwin/v2/description.md create mode 100644 services/pnid-to-itwin/v2/operations/create-inference-run/description.md create mode 100644 services/pnid-to-itwin/v2/operations/create-inference-run/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/create-inference/description.md create mode 100644 services/pnid-to-itwin/v2/operations/create-inference/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/delete-inference-input/description.md create mode 100644 services/pnid-to-itwin/v2/operations/delete-inference-input/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/delete-inference-run/description.md create mode 100644 services/pnid-to-itwin/v2/operations/delete-inference-run/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/delete-inference/description.md create mode 100644 services/pnid-to-itwin/v2/operations/delete-inference/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference-input-content/description.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference-input-content/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference-inputs/description.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference-inputs/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference-run-result-content/description.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference-run-result-content/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference-run-results/description.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference-run-results/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference-run/description.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference-run/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference/description.md create mode 100644 services/pnid-to-itwin/v2/operations/get-inference/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/get-itwin-inferences/description.md create mode 100644 services/pnid-to-itwin/v2/operations/get-itwin-inferences/displayName.md create mode 100644 services/pnid-to-itwin/v2/operations/upload-inference-input-content/description.md create mode 100644 services/pnid-to-itwin/v2/operations/upload-inference-input-content/displayName.md create mode 100644 services/projects/v1/description.md create mode 100644 services/projects/v1/operations/add-project-team-member/description.md create mode 100644 services/projects/v1/operations/add-project-team-member/displayName.md create mode 100644 services/projects/v1/operations/add-project-to-my-favorites/description.md create mode 100644 services/projects/v1/operations/add-project-to-my-favorites/displayName.md create mode 100644 services/projects/v1/operations/add-project-to-my-recents/description.md create mode 100644 services/projects/v1/operations/add-project-to-my-recents/displayName.md create mode 100644 services/projects/v1/operations/create-project-role/description.md create mode 100644 services/projects/v1/operations/create-project-role/displayName.md create mode 100644 services/projects/v1/operations/create-project/description.md create mode 100644 services/projects/v1/operations/create-project/displayName.md create mode 100644 services/projects/v1/operations/delete-project-role/description.md create mode 100644 services/projects/v1/operations/delete-project-role/displayName.md create mode 100644 services/projects/v1/operations/delete-project/description.md create mode 100644 services/projects/v1/operations/delete-project/displayName.md create mode 100644 services/projects/v1/operations/get-my-favorite-projects/description.md create mode 100644 services/projects/v1/operations/get-my-favorite-projects/displayName.md create mode 100644 services/projects/v1/operations/get-my-recently-used-projects/description.md create mode 100644 services/projects/v1/operations/get-my-recently-used-projects/displayName.md create mode 100644 services/projects/v1/operations/get-project-roles/description.md create mode 100644 services/projects/v1/operations/get-project-roles/displayName.md create mode 100644 services/projects/v1/operations/get-project-team-member-details/description.md create mode 100644 services/projects/v1/operations/get-project-team-member-details/displayName.md create mode 100644 services/projects/v1/operations/get-project-team-members/description.md create mode 100644 services/projects/v1/operations/get-project-team-members/displayName.md create mode 100644 services/projects/v1/operations/get-project/description.md create mode 100644 services/projects/v1/operations/get-project/displayName.md create mode 100644 services/projects/v1/operations/get-user-permissions/description.md create mode 100644 services/projects/v1/operations/get-user-permissions/displayName.md create mode 100644 services/projects/v1/operations/my-projects/description.md create mode 100644 services/projects/v1/operations/my-projects/displayName.md create mode 100644 services/projects/v1/operations/remove-project-from-my-favorites/description.md create mode 100644 services/projects/v1/operations/remove-project-from-my-favorites/displayName.md create mode 100644 services/projects/v1/operations/remove-project-team-member/description.md create mode 100644 services/projects/v1/operations/remove-project-team-member/displayName.md create mode 100644 services/projects/v1/operations/update-project-role/description.md create mode 100644 services/projects/v1/operations/update-project-role/displayName.md create mode 100644 services/projects/v1/operations/update-project-team-member-roles/description.md create mode 100644 services/projects/v1/operations/update-project-team-member-roles/displayName.md create mode 100644 services/projects/v1/operations/update-project/description.md create mode 100644 services/projects/v1/operations/update-project/displayName.md create mode 100644 services/projectwise365-insights/v1/description.md create mode 100644 services/projectwise365-insights/v1/operations/project-metadata/description.md create mode 100644 services/projectwise365-insights/v1/operations/project-metadata/displayName.md create mode 100644 services/projectwise365-insights/v1/operations/project-odata/description.md create mode 100644 services/projectwise365-insights/v1/operations/project-odata/displayName.md create mode 100644 services/projectwise365-insights/v1/operations/project-schema/description.md create mode 100644 services/projectwise365-insights/v1/operations/project-schema/displayName.md create mode 100644 services/reality-data/v1/description.md create mode 100644 services/reality-data/v1/operations/associate-to-project/description.md create mode 100644 services/reality-data/v1/operations/associate-to-project/displayName.md create mode 100644 services/reality-data/v1/operations/create-reality-data/description.md create mode 100644 services/reality-data/v1/operations/create-reality-data/displayName.md create mode 100644 services/reality-data/v1/operations/delete-reality-data/description.md create mode 100644 services/reality-data/v1/operations/delete-reality-data/displayName.md create mode 100644 services/reality-data/v1/operations/dissociate-from-project/description.md create mode 100644 services/reality-data/v1/operations/dissociate-from-project/displayName.md create mode 100644 services/reality-data/v1/operations/get-all-reality-data/description.md create mode 100644 services/reality-data/v1/operations/get-all-reality-data/displayName.md create mode 100644 services/reality-data/v1/operations/get-reality-data-container/description.md create mode 100644 services/reality-data/v1/operations/get-reality-data-container/displayName.md create mode 100644 services/reality-data/v1/operations/get-reality-data-details/description.md create mode 100644 services/reality-data/v1/operations/get-reality-data-details/displayName.md create mode 100644 services/reality-data/v1/operations/get-reality-data-projects/description.md create mode 100644 services/reality-data/v1/operations/get-reality-data-projects/displayName.md create mode 100644 services/reality-data/v1/operations/update-reality-data/description.md create mode 100644 services/reality-data/v1/operations/update-reality-data/displayName.md create mode 100644 services/reality-management/v1/description.md create mode 100644 services/reality-management/v1/operations/associate-to-iTwin/description.md create mode 100644 services/reality-management/v1/operations/associate-to-iTwin/displayName.md create mode 100644 services/reality-management/v1/operations/create-reality-data/description.md create mode 100644 services/reality-management/v1/operations/create-reality-data/displayName.md create mode 100644 services/reality-management/v1/operations/delete-reality-data/description.md create mode 100644 services/reality-management/v1/operations/delete-reality-data/displayName.md create mode 100644 services/reality-management/v1/operations/dissociate-from-iTwin/description.md create mode 100644 services/reality-management/v1/operations/dissociate-from-iTwin/displayName.md create mode 100644 services/reality-management/v1/operations/get-all-reality-data/description.md create mode 100644 services/reality-management/v1/operations/get-all-reality-data/displayName.md create mode 100644 services/reality-management/v1/operations/get-read-access-to-reality-data-container/description.md create mode 100644 services/reality-management/v1/operations/get-read-access-to-reality-data-container/displayName.md create mode 100644 services/reality-management/v1/operations/get-reality-data-details/description.md create mode 100644 services/reality-management/v1/operations/get-reality-data-details/displayName.md create mode 100644 services/reality-management/v1/operations/get-reality-data-iTwins/description.md create mode 100644 services/reality-management/v1/operations/get-reality-data-iTwins/displayName.md create mode 100644 services/reality-management/v1/operations/get-write-access-to-reality-data-container/description.md create mode 100644 services/reality-management/v1/operations/get-write-access-to-reality-data-container/displayName.md create mode 100644 services/reality-management/v1/operations/update-reality-data/description.md create mode 100644 services/reality-management/v1/operations/update-reality-data/displayName.md create mode 100644 services/realityconversion/v1/description.md create mode 100644 services/realityconversion/v1/operations/jobs-create/description.md create mode 100644 services/realityconversion/v1/operations/jobs-create/displayName.md create mode 100644 services/realityconversion/v1/operations/jobs-delete/description.md create mode 100644 services/realityconversion/v1/operations/jobs-delete/displayName.md create mode 100644 services/realityconversion/v1/operations/jobs-get/description.md create mode 100644 services/realityconversion/v1/operations/jobs-get/displayName.md create mode 100644 services/realityconversion/v1/operations/jobs-patch/description.md create mode 100644 services/realityconversion/v1/operations/jobs-patch/displayName.md create mode 100644 services/realityconversion/v1/operations/jobs-progress/description.md create mode 100644 services/realityconversion/v1/operations/jobs-progress/displayName.md create mode 100644 services/realitydataanalysis/v1/description.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-create/description.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-create/displayName.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-delete/description.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-delete/displayName.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-get-all/description.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-get-all/displayName.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-get/description.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-get/displayName.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-patch/description.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-patch/displayName.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-progress/description.md create mode 100644 services/realitydataanalysis/v1/operations/jobs-progress/displayName.md create mode 100644 services/reporting/v2/description.md create mode 100644 services/reporting/v2/operations/create-apikey/description.md create mode 100644 services/reporting/v2/operations/create-apikey/displayName.md create mode 100644 services/reporting/v2/operations/create-report-mapping/description.md create mode 100644 services/reporting/v2/operations/create-report-mapping/displayName.md create mode 100644 services/reporting/v2/operations/create-report/description.md create mode 100644 services/reporting/v2/operations/create-report/displayName.md create mode 100644 services/reporting/v2/operations/delete-report-mapping/description.md create mode 100644 services/reporting/v2/operations/delete-report-mapping/displayName.md create mode 100644 services/reporting/v2/operations/delete-report/description.md create mode 100644 services/reporting/v2/operations/delete-report/displayName.md create mode 100644 services/reporting/v2/operations/get-apikey/description.md create mode 100644 services/reporting/v2/operations/get-apikey/displayName.md create mode 100644 services/reporting/v2/operations/get-apikeys/description.md create mode 100644 services/reporting/v2/operations/get-apikeys/displayName.md create mode 100644 services/reporting/v2/operations/get-itwin-reports/description.md create mode 100644 services/reporting/v2/operations/get-itwin-reports/displayName.md create mode 100644 services/reporting/v2/operations/get-report-mappings/description.md create mode 100644 services/reporting/v2/operations/get-report-mappings/displayName.md create mode 100644 services/reporting/v2/operations/get-report/description.md create mode 100644 services/reporting/v2/operations/get-report/displayName.md create mode 100644 services/reporting/v2/operations/odata-entity/description.md create mode 100644 services/reporting/v2/operations/odata-entity/displayName.md create mode 100644 services/reporting/v2/operations/odata-metadata/description.md create mode 100644 services/reporting/v2/operations/odata-metadata/displayName.md create mode 100644 services/reporting/v2/operations/odata/description.md create mode 100644 services/reporting/v2/operations/odata/displayName.md create mode 100644 services/reporting/v2/operations/revoke-apikey/description.md create mode 100644 services/reporting/v2/operations/revoke-apikey/displayName.md create mode 100644 services/reporting/v2/operations/update-apikey/description.md create mode 100644 services/reporting/v2/operations/update-apikey/displayName.md create mode 100644 services/reporting/v2/operations/update-report/description.md create mode 100644 services/reporting/v2/operations/update-report/displayName.md create mode 100644 services/savedviews/v1/description.md create mode 100644 services/savedviews/v1/operations/add-image/description.md create mode 100644 services/savedviews/v1/operations/add-image/displayName.md create mode 100644 services/savedviews/v1/operations/create-extension/description.md create mode 100644 services/savedviews/v1/operations/create-extension/displayName.md create mode 100644 services/savedviews/v1/operations/create-group/description.md create mode 100644 services/savedviews/v1/operations/create-group/displayName.md create mode 100644 services/savedviews/v1/operations/create-savedview/description.md create mode 100644 services/savedviews/v1/operations/create-savedview/displayName.md create mode 100644 services/savedviews/v1/operations/create-tag/description.md create mode 100644 services/savedviews/v1/operations/create-tag/displayName.md create mode 100644 services/savedviews/v1/operations/delete-extension/description.md create mode 100644 services/savedviews/v1/operations/delete-extension/displayName.md create mode 100644 services/savedviews/v1/operations/delete-group/description.md create mode 100644 services/savedviews/v1/operations/delete-group/displayName.md create mode 100644 services/savedviews/v1/operations/delete-savedview/description.md create mode 100644 services/savedviews/v1/operations/delete-savedview/displayName.md create mode 100644 services/savedviews/v1/operations/delete-tag/description.md create mode 100644 services/savedviews/v1/operations/delete-tag/displayName.md create mode 100644 services/savedviews/v1/operations/get-all-extensions/description.md create mode 100644 services/savedviews/v1/operations/get-all-extensions/displayName.md create mode 100644 services/savedviews/v1/operations/get-all-groups/description.md create mode 100644 services/savedviews/v1/operations/get-all-groups/displayName.md create mode 100644 services/savedviews/v1/operations/get-all-savedviews/description.md create mode 100644 services/savedviews/v1/operations/get-all-savedviews/displayName.md create mode 100644 services/savedviews/v1/operations/get-all-tags/description.md create mode 100644 services/savedviews/v1/operations/get-all-tags/displayName.md create mode 100644 services/savedviews/v1/operations/get-extension/description.md create mode 100644 services/savedviews/v1/operations/get-extension/displayName.md create mode 100644 services/savedviews/v1/operations/get-group/description.md create mode 100644 services/savedviews/v1/operations/get-group/displayName.md create mode 100644 services/savedviews/v1/operations/get-image/description.md create mode 100644 services/savedviews/v1/operations/get-image/displayName.md create mode 100644 services/savedviews/v1/operations/get-savedview/description.md create mode 100644 services/savedviews/v1/operations/get-savedview/displayName.md create mode 100644 services/savedviews/v1/operations/get-tag/description.md create mode 100644 services/savedviews/v1/operations/get-tag/displayName.md create mode 100644 services/savedviews/v1/operations/update-group/description.md create mode 100644 services/savedviews/v1/operations/update-group/displayName.md create mode 100644 services/savedviews/v1/operations/update-savedview/description.md create mode 100644 services/savedviews/v1/operations/update-savedview/displayName.md create mode 100644 services/savedviews/v1/operations/update-tag/description.md create mode 100644 services/savedviews/v1/operations/update-tag/displayName.md create mode 100644 services/sensor-data/v1/description.md create mode 100644 services/sensor-data/v1/operations/get-nodes/description.md create mode 100644 services/sensor-data/v1/operations/get-nodes/displayName.md create mode 100644 services/sensor-data/v1/operations/process-integration/description.md create mode 100644 services/sensor-data/v1/operations/process-integration/displayName.md create mode 100644 services/sensor-data/v1/operations/query-raw-data/description.md create mode 100644 services/sensor-data/v1/operations/query-raw-data/displayName.md create mode 100644 services/sensor-data/v1/operations/remove-data/description.md create mode 100644 services/sensor-data/v1/operations/remove-data/displayName.md create mode 100644 services/sensor-data/v1/operations/upload-data/description.md create mode 100644 services/sensor-data/v1/operations/upload-data/displayName.md create mode 100644 services/storage-container/v1/description.md create mode 100644 services/storage-container/v1/operations/clone-storage-container/description.md create mode 100644 services/storage-container/v1/operations/clone-storage-container/displayName.md create mode 100644 services/storage-container/v1/operations/create-storage-container/description.md create mode 100644 services/storage-container/v1/operations/create-storage-container/displayName.md create mode 100644 services/storage-container/v1/operations/delete-storage-container/description.md create mode 100644 services/storage-container/v1/operations/delete-storage-container/displayName.md create mode 100644 services/storage-container/v1/operations/get-single-storage-container/description.md create mode 100644 services/storage-container/v1/operations/get-single-storage-container/displayName.md create mode 100644 services/storage-container/v1/operations/get-storage-containers/description.md create mode 100644 services/storage-container/v1/operations/get-storage-containers/displayName.md create mode 100644 services/storage-container/v1/operations/update-container-metadata-json/description.md create mode 100644 services/storage-container/v1/operations/update-container-metadata-json/displayName.md create mode 100644 services/storage/v1/description.md create mode 100644 services/storage/v1/operations/complete-file-creation/description.md create mode 100644 services/storage/v1/operations/complete-file-creation/displayName.md create mode 100644 services/storage/v1/operations/create-file/description.md create mode 100644 services/storage/v1/operations/create-file/displayName.md create mode 100644 services/storage/v1/operations/create-folder/description.md create mode 100644 services/storage/v1/operations/create-folder/displayName.md create mode 100644 services/storage/v1/operations/delete-file-from-recycle-bin/description.md create mode 100644 services/storage/v1/operations/delete-file-from-recycle-bin/displayName.md create mode 100644 services/storage/v1/operations/delete-file/description.md create mode 100644 services/storage/v1/operations/delete-file/displayName.md create mode 100644 services/storage/v1/operations/delete-folder-from-recycle-bin/description.md create mode 100644 services/storage/v1/operations/delete-folder-from-recycle-bin/displayName.md create mode 100644 services/storage/v1/operations/delete-folder/description.md create mode 100644 services/storage/v1/operations/delete-folder/displayName.md create mode 100644 services/storage/v1/operations/download-file/description.md create mode 100644 services/storage/v1/operations/download-file/displayName.md create mode 100644 services/storage/v1/operations/get-file/description.md create mode 100644 services/storage/v1/operations/get-file/displayName.md create mode 100644 services/storage/v1/operations/get-files-in-folder/description.md create mode 100644 services/storage/v1/operations/get-files-in-folder/displayName.md create mode 100644 services/storage/v1/operations/get-folder/description.md create mode 100644 services/storage/v1/operations/get-folder/displayName.md create mode 100644 services/storage/v1/operations/get-folders-and-files-in-folder/description.md create mode 100644 services/storage/v1/operations/get-folders-and-files-in-folder/displayName.md create mode 100644 services/storage/v1/operations/get-folders-and-files-in-recycle-bin/description.md create mode 100644 services/storage/v1/operations/get-folders-and-files-in-recycle-bin/displayName.md create mode 100644 services/storage/v1/operations/get-folders-in-folder/description.md create mode 100644 services/storage/v1/operations/get-folders-in-folder/displayName.md create mode 100644 services/storage/v1/operations/get-top-level-folders-and-files-by-project/description.md create mode 100644 services/storage/v1/operations/get-top-level-folders-and-files-by-project/displayName.md create mode 100644 services/storage/v1/operations/lock-files-in-folder/description.md create mode 100644 services/storage/v1/operations/lock-files-in-folder/displayName.md create mode 100644 services/storage/v1/operations/move-file-legacy/description.md create mode 100644 services/storage/v1/operations/move-file-legacy/displayName.md create mode 100644 services/storage/v1/operations/move-file/description.md create mode 100644 services/storage/v1/operations/move-file/displayName.md create mode 100644 services/storage/v1/operations/move-folder/description.md create mode 100644 services/storage/v1/operations/move-folder/displayName.md create mode 100644 services/storage/v1/operations/restore-file/description.md create mode 100644 services/storage/v1/operations/restore-file/displayName.md create mode 100644 services/storage/v1/operations/restore-folder/description.md create mode 100644 services/storage/v1/operations/restore-folder/displayName.md create mode 100644 services/storage/v1/operations/search-for-folders-and-files-in-folder/description.md create mode 100644 services/storage/v1/operations/search-for-folders-and-files-in-folder/displayName.md create mode 100644 services/storage/v1/operations/unlock-files-in-folder/description.md create mode 100644 services/storage/v1/operations/unlock-files-in-folder/displayName.md create mode 100644 services/storage/v1/operations/update-file-content/description.md create mode 100644 services/storage/v1/operations/update-file-content/displayName.md create mode 100644 services/storage/v1/operations/update-file/description.md create mode 100644 services/storage/v1/operations/update-file/displayName.md create mode 100644 services/storage/v1/operations/update-folder/description.md create mode 100644 services/storage/v1/operations/update-folder/displayName.md create mode 100644 services/synchronization/v1/description.md create mode 100644 services/synchronization/v1/operations/add-manifest-connection-sourcefile/description.md create mode 100644 services/synchronization/v1/operations/add-manifest-connection-sourcefile/displayName.md create mode 100644 services/synchronization/v1/operations/add-storage-connection-sourcefile/description.md create mode 100644 services/synchronization/v1/operations/add-storage-connection-sourcefile/displayName.md create mode 100644 services/synchronization/v1/operations/create-connection-configuration/description.md create mode 100644 services/synchronization/v1/operations/create-connection-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/create-imodel-configuration/description.md create mode 100644 services/synchronization/v1/operations/create-imodel-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/create-itwin-configuration/description.md create mode 100644 services/synchronization/v1/operations/create-itwin-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/create-manifest-connection-run/description.md create mode 100644 services/synchronization/v1/operations/create-manifest-connection-run/displayName.md create mode 100644 services/synchronization/v1/operations/create-manifest-connection/description.md create mode 100644 services/synchronization/v1/operations/create-manifest-connection/displayName.md create mode 100644 services/synchronization/v1/operations/create-storage-connection/description.md create mode 100644 services/synchronization/v1/operations/create-storage-connection/displayName.md create mode 100644 services/synchronization/v1/operations/delete-connection-configuration/description.md create mode 100644 services/synchronization/v1/operations/delete-connection-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/delete-imodel-configuration/description.md create mode 100644 services/synchronization/v1/operations/delete-imodel-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/delete-itwin-configuration/description.md create mode 100644 services/synchronization/v1/operations/delete-itwin-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/delete-manifest-connection/description.md create mode 100644 services/synchronization/v1/operations/delete-manifest-connection/displayName.md create mode 100644 services/synchronization/v1/operations/delete-storage-connection/description.md create mode 100644 services/synchronization/v1/operations/delete-storage-connection/displayName.md create mode 100644 services/synchronization/v1/operations/get-authorization-information/description.md create mode 100644 services/synchronization/v1/operations/get-authorization-information/displayName.md create mode 100644 services/synchronization/v1/operations/get-connection-configuration/description.md create mode 100644 services/synchronization/v1/operations/get-connection-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/get-connections/description.md create mode 100644 services/synchronization/v1/operations/get-connections/displayName.md create mode 100644 services/synchronization/v1/operations/get-imodel-configuration/description.md create mode 100644 services/synchronization/v1/operations/get-imodel-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/get-itwin-configuration/description.md create mode 100644 services/synchronization/v1/operations/get-itwin-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/get-manifest-connection-run/description.md create mode 100644 services/synchronization/v1/operations/get-manifest-connection-run/displayName.md create mode 100644 services/synchronization/v1/operations/get-manifest-connection-runs/description.md create mode 100644 services/synchronization/v1/operations/get-manifest-connection-runs/displayName.md create mode 100644 services/synchronization/v1/operations/get-manifest-connection-sourcefile/description.md create mode 100644 services/synchronization/v1/operations/get-manifest-connection-sourcefile/displayName.md create mode 100644 services/synchronization/v1/operations/get-manifest-connection-sourcefiles/description.md create mode 100644 services/synchronization/v1/operations/get-manifest-connection-sourcefiles/displayName.md create mode 100644 services/synchronization/v1/operations/get-manifest-connection/description.md create mode 100644 services/synchronization/v1/operations/get-manifest-connection/displayName.md create mode 100644 services/synchronization/v1/operations/get-manifest-connections/description.md create mode 100644 services/synchronization/v1/operations/get-manifest-connections/displayName.md create mode 100644 services/synchronization/v1/operations/get-storage-connection-run/description.md create mode 100644 services/synchronization/v1/operations/get-storage-connection-run/displayName.md create mode 100644 services/synchronization/v1/operations/get-storage-connection-runs/description.md create mode 100644 services/synchronization/v1/operations/get-storage-connection-runs/displayName.md create mode 100644 services/synchronization/v1/operations/get-storage-connection-sourcefile/description.md create mode 100644 services/synchronization/v1/operations/get-storage-connection-sourcefile/displayName.md create mode 100644 services/synchronization/v1/operations/get-storage-connection-sourcefiles/description.md create mode 100644 services/synchronization/v1/operations/get-storage-connection-sourcefiles/displayName.md create mode 100644 services/synchronization/v1/operations/get-storage-connection/description.md create mode 100644 services/synchronization/v1/operations/get-storage-connection/displayName.md create mode 100644 services/synchronization/v1/operations/get-storage-connections/description.md create mode 100644 services/synchronization/v1/operations/get-storage-connections/displayName.md create mode 100644 services/synchronization/v1/operations/patch-connection-configuration/description.md create mode 100644 services/synchronization/v1/operations/patch-connection-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/patch-imodel-configuration/description.md create mode 100644 services/synchronization/v1/operations/patch-imodel-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/patch-itwin-configuration/description.md create mode 100644 services/synchronization/v1/operations/patch-itwin-configuration/displayName.md create mode 100644 services/synchronization/v1/operations/remove-manifest-connection-sourcefile/description.md create mode 100644 services/synchronization/v1/operations/remove-manifest-connection-sourcefile/displayName.md create mode 100644 services/synchronization/v1/operations/remove-storage-connection-sourcefile/description.md create mode 100644 services/synchronization/v1/operations/remove-storage-connection-sourcefile/displayName.md create mode 100644 services/synchronization/v1/operations/run-storage-connection/description.md create mode 100644 services/synchronization/v1/operations/run-storage-connection/displayName.md create mode 100644 services/synchronization/v1/operations/update-manifest-connection-sourcefile/description.md create mode 100644 services/synchronization/v1/operations/update-manifest-connection-sourcefile/displayName.md create mode 100644 services/synchronization/v1/operations/update-manifest-connection/description.md create mode 100644 services/synchronization/v1/operations/update-manifest-connection/displayName.md create mode 100644 services/synchronization/v1/operations/update-storage-connection-sourcefile/description.md create mode 100644 services/synchronization/v1/operations/update-storage-connection-sourcefile/displayName.md create mode 100644 services/synchronization/v1/operations/update-storage-connection/description.md create mode 100644 services/synchronization/v1/operations/update-storage-connection/displayName.md create mode 100644 services/transformations/v1/description.md create mode 100644 services/transformations/v1/operations/alignimodeldata/description.md create mode 100644 services/transformations/v1/operations/alignimodeldata/displayName.md create mode 100644 services/transformations/v1/operations/combineimodels/description.md create mode 100644 services/transformations/v1/operations/combineimodels/displayName.md create mode 100644 services/transformations/v1/operations/combinephysicalmodels/description.md create mode 100644 services/transformations/v1/operations/combinephysicalmodels/displayName.md create mode 100644 services/transformations/v1/operations/combinephysicalmodelsv2/description.md create mode 100644 services/transformations/v1/operations/combinephysicalmodelsv2/displayName.md create mode 100644 services/transformations/v1/operations/create-transformation/description.md create mode 100644 services/transformations/v1/operations/create-transformation/displayName.md create mode 100644 services/transformations/v1/operations/createfork/description.md create mode 100644 services/transformations/v1/operations/createfork/displayName.md create mode 100644 services/transformations/v1/operations/delete-configuration/description.md create mode 100644 services/transformations/v1/operations/delete-configuration/displayName.md create mode 100644 services/transformations/v1/operations/delete-transformation/description.md create mode 100644 services/transformations/v1/operations/delete-transformation/displayName.md create mode 100644 services/transformations/v1/operations/filterbyviewdefinition/description.md create mode 100644 services/transformations/v1/operations/filterbyviewdefinition/displayName.md create mode 100644 services/transformations/v1/operations/filterimodel/description.md create mode 100644 services/transformations/v1/operations/filterimodel/displayName.md create mode 100644 services/transformations/v1/operations/filtersubcategories/description.md create mode 100644 services/transformations/v1/operations/filtersubcategories/displayName.md create mode 100644 services/transformations/v1/operations/get-all-configurations/description.md create mode 100644 services/transformations/v1/operations/get-all-configurations/displayName.md create mode 100644 services/transformations/v1/operations/get-all-transformations/description.md create mode 100644 services/transformations/v1/operations/get-all-transformations/displayName.md create mode 100644 services/transformations/v1/operations/get-configuration/description.md create mode 100644 services/transformations/v1/operations/get-configuration/displayName.md create mode 100644 services/transformations/v1/operations/get-transformation/description.md create mode 100644 services/transformations/v1/operations/get-transformation/displayName.md create mode 100644 services/transformations/v1/operations/groupandmap/description.md create mode 100644 services/transformations/v1/operations/groupandmap/displayName.md create mode 100644 services/transformations/v1/operations/importimodel/description.md create mode 100644 services/transformations/v1/operations/importimodel/displayName.md create mode 100644 services/transformations/v1/operations/mergefork/description.md create mode 100644 services/transformations/v1/operations/mergefork/displayName.md create mode 100644 services/transformations/v1/operations/mergeimodel/description.md create mode 100644 services/transformations/v1/operations/mergeimodel/displayName.md create mode 100644 services/transformations/v1/operations/populatefederationguids/description.md create mode 100644 services/transformations/v1/operations/populatefederationguids/displayName.md create mode 100644 services/users/v1/description.md create mode 100644 services/users/v1/operations/get-user/description.md create mode 100644 services/users/v1/operations/get-user/displayName.md create mode 100644 services/users/v1/operations/get-users-by-id-list/description.md create mode 100644 services/users/v1/operations/get-users-by-id-list/displayName.md create mode 100644 services/users/v1/operations/get-users/description.md create mode 100644 services/users/v1/operations/get-users/displayName.md create mode 100644 services/users/v1/operations/me/description.md create mode 100644 services/users/v1/operations/me/displayName.md create mode 100644 services/validation/v1/description.md create mode 100644 services/validation/v1/operations/create-validation-propertyvalue-rule/description.md create mode 100644 services/validation/v1/operations/create-validation-propertyvalue-rule/displayName.md create mode 100644 services/validation/v1/operations/create-validation-propertyvalue-tests/description.md create mode 100644 services/validation/v1/operations/create-validation-propertyvalue-tests/displayName.md create mode 100644 services/validation/v1/operations/delete-validation-propertyvalue-rule/description.md create mode 100644 services/validation/v1/operations/delete-validation-propertyvalue-rule/displayName.md create mode 100644 services/validation/v1/operations/delete-validation-propertyvalue-run/description.md create mode 100644 services/validation/v1/operations/delete-validation-propertyvalue-run/displayName.md create mode 100644 services/validation/v1/operations/delete-validation-propertyvalue-test/description.md create mode 100644 services/validation/v1/operations/delete-validation-propertyvalue-test/displayName.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-properties/description.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-properties/displayName.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-result/description.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-result/displayName.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-rule-templates/description.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-rule-templates/displayName.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-rule/description.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-rule/displayName.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-rules/description.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-rules/displayName.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-run/description.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-run/displayName.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-runs/description.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-runs/displayName.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-test/description.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-test/displayName.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-tests/description.md create mode 100644 services/validation/v1/operations/get-validation-propertyvalue-tests/displayName.md create mode 100644 services/validation/v1/operations/run-validation-propertyvalue-test/description.md create mode 100644 services/validation/v1/operations/run-validation-propertyvalue-test/displayName.md create mode 100644 services/validation/v1/operations/update-validation-propertyvalue-rule/description.md create mode 100644 services/validation/v1/operations/update-validation-propertyvalue-rule/displayName.md create mode 100644 services/validation/v1/operations/update-validation-propertyvalue-test/description.md create mode 100644 services/validation/v1/operations/update-validation-propertyvalue-test/displayName.md create mode 100644 services/webhooks/v2/description.md create mode 100644 services/webhooks/v2/operations/create-webhook/description.md create mode 100644 services/webhooks/v2/operations/create-webhook/displayName.md create mode 100644 services/webhooks/v2/operations/delete-webhook/description.md create mode 100644 services/webhooks/v2/operations/delete-webhook/displayName.md create mode 100644 services/webhooks/v2/operations/get-webhook/description.md create mode 100644 services/webhooks/v2/operations/get-webhook/displayName.md create mode 100644 services/webhooks/v2/operations/get-webhooks/description.md create mode 100644 services/webhooks/v2/operations/get-webhooks/displayName.md create mode 100644 services/webhooks/v2/operations/update-webhook/description.md create mode 100644 services/webhooks/v2/operations/update-webhook/displayName.md diff --git a/apis/operations/description/Authorization.md b/apis/operations/description/Authorization.md new file mode 100644 index 0000000..d25193f --- /dev/null +++ b/apis/operations/description/Authorization.md @@ -0,0 +1,5 @@ +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. diff --git a/apis/operations/description/OrganizationAdministrator.md b/apis/operations/description/OrganizationAdministrator.md new file mode 100644 index 0000000..41bb754 --- /dev/null +++ b/apis/operations/description/OrganizationAdministrator.md @@ -0,0 +1 @@ +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. \ No newline at end of file diff --git a/apis/operations/description/ProjectsDeprecated.md b/apis/operations/description/ProjectsDeprecated.md new file mode 100644 index 0000000..594e36b --- /dev/null +++ b/apis/operations/description/ProjectsDeprecated.md @@ -0,0 +1,5 @@ +### **This API is being deprecated** + +This API is being superseded by the [iTwins API](https://developer.bentley.com/apis/itwins/) and the [Access Control API](https://developer.bentley.com/apis/access-control/). Please consider transitioning your software to the iTwins API. + +With any questions, please first consult the [iTwins API FAQ](https://developer.bentley.com/apis/itwins/#faq). If your question isn't answered there, please use our [Community Support Channels](https://developer.bentley.com/support/) to contact our developers. diff --git a/apis/operations/description/RateLimits.md b/apis/operations/description/RateLimits.md new file mode 100644 index 0000000..685e3c9 --- /dev/null +++ b/apis/operations/description/RateLimits.md @@ -0,0 +1,3 @@ +### Rate limits + +All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page. \ No newline at end of file diff --git a/apis/operations/description/RbacPermissions.md b/apis/operations/description/RbacPermissions.md new file mode 100644 index 0000000..5959512 --- /dev/null +++ b/apis/operations/description/RbacPermissions.md @@ -0,0 +1,5 @@ +### Authorization + +User must be an Organization Administrator for the Organization that owns a given Project or have `{permission}` permission assigned at the Project level. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. \ No newline at end of file diff --git a/apis/operations/description/iTwinsRBACPermission.md b/apis/operations/description/iTwinsRBACPermission.md new file mode 100644 index 0000000..00c9547 --- /dev/null +++ b/apis/operations/description/iTwinsRBACPermission.md @@ -0,0 +1,5 @@ +### Authorization + +User must have the `{permission}` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. diff --git a/services/access-control/v2/description.md b/services/access-control/v2/description.md new file mode 100644 index 0000000..667782e --- /dev/null +++ b/services/access-control/v2/description.md @@ -0,0 +1 @@ +Manage Access Controls for your iTwin member using iTwin roles and permissions. \ No newline at end of file diff --git a/services/access-control/v2/operations/add-itwin-group-members/description.md b/services/access-control/v2/operations/add-itwin-group-members/description.md new file mode 100644 index 0000000..b012ef9 --- /dev/null +++ b/services/access-control/v2/operations/add-itwin-group-members/description.md @@ -0,0 +1,11 @@ +--- + +Add new iTwin group members + +The total number of roles assigned in this request must not exceed 50. This can be achieved with many different configurations. For example, 1 role can be assigned to 50 groups, or 5 roles can be assigned to 10 groups, both resulting in 50 role assignments. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/add-itwin-group-members/displayName.md b/services/access-control/v2/operations/add-itwin-group-members/displayName.md new file mode 100644 index 0000000..68c1b77 --- /dev/null +++ b/services/access-control/v2/operations/add-itwin-group-members/displayName.md @@ -0,0 +1 @@ +Add iTwin group members \ No newline at end of file diff --git a/services/access-control/v2/operations/add-itwin-owner-member/description.md b/services/access-control/v2/operations/add-itwin-owner-member/description.md new file mode 100644 index 0000000..934fc92 --- /dev/null +++ b/services/access-control/v2/operations/add-itwin-owner-member/description.md @@ -0,0 +1,15 @@ +--- + +Add new iTwin owner members. iTwin Owners are users which have full control over the iTwin. Each owner is granted all permissions on the iTwin, allowing them to perform any action on the iTwin they own. + +Users which are external (i.e. not in the same organization as the iTwin) are not automatically added to the iTwin. Instead, they're invited. Users which are not external, are immediately added as members on the iTwin. + +Invited individuals will recieve an invitation via Email, where they'll be prompted to accept the invitation. Upon accepting, they'll then become a member of the iTwin. + +{!Authorization.md!} + +You must be an owner to add other owners. + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/add-itwin-owner-member/displayName.md b/services/access-control/v2/operations/add-itwin-owner-member/displayName.md new file mode 100644 index 0000000..45ee905 --- /dev/null +++ b/services/access-control/v2/operations/add-itwin-owner-member/displayName.md @@ -0,0 +1 @@ +Add iTwin owner member \ No newline at end of file diff --git a/services/access-control/v2/operations/add-itwin-user-members/description.md b/services/access-control/v2/operations/add-itwin-user-members/description.md new file mode 100644 index 0000000..2fa089c --- /dev/null +++ b/services/access-control/v2/operations/add-itwin-user-members/description.md @@ -0,0 +1,13 @@ +--- + +Add or Invite new iTwin user members. Users which are external (i.e. not in the same organization as the iTwin) are not automatically added to the iTwin. Instead, they're invited. Users which are not external, are immediately added as members on the iTwin. + +Invited individuals will recieve an invitation via Email, where they'll be prompted to accept the invitation. Upon accepting, they'll then become a member of the iTwin. + +The total number of roles assigned in this request must not exceed 50. This can be achieved with many different configurations. For example, 1 role can be assigned to 50 users, or 5 roles can be assigned to 10 users, both resulting in 50 role assignments. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/add-itwin-user-members/displayName.md b/services/access-control/v2/operations/add-itwin-user-members/displayName.md new file mode 100644 index 0000000..0e28ddd --- /dev/null +++ b/services/access-control/v2/operations/add-itwin-user-members/displayName.md @@ -0,0 +1 @@ +Add iTwin user members \ No newline at end of file diff --git a/services/access-control/v2/operations/create-iTwin-role/description.md b/services/access-control/v2/operations/create-iTwin-role/description.md new file mode 100644 index 0000000..721da6d --- /dev/null +++ b/services/access-control/v2/operations/create-iTwin-role/description.md @@ -0,0 +1,9 @@ +--- + +Create a new iTwin role. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/create-iTwin-role/displayName.md b/services/access-control/v2/operations/create-iTwin-role/displayName.md new file mode 100644 index 0000000..cd6904e --- /dev/null +++ b/services/access-control/v2/operations/create-iTwin-role/displayName.md @@ -0,0 +1 @@ +Create iTwin role \ No newline at end of file diff --git a/services/access-control/v2/operations/create-itwin-group/description.md b/services/access-control/v2/operations/create-itwin-group/description.md new file mode 100644 index 0000000..f0696c0 --- /dev/null +++ b/services/access-control/v2/operations/create-itwin-group/description.md @@ -0,0 +1,15 @@ +--- + +Create a new iTwin group. + +{!Authorization.md!} + +### Authorization + +A user can create a Group by being assigned the `administration_manage_groups` on the iTwin level. A user also can create a Group on an iTwin by either being an Organization Administrator for the Organization that owns the given iTwin, or an owner of the iTwin. + +For creation of Groups on the Account iTwin, the user must be an Organization Administrator for the Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +--- diff --git a/services/access-control/v2/operations/create-itwin-group/displayName.md b/services/access-control/v2/operations/create-itwin-group/displayName.md new file mode 100644 index 0000000..c9628f1 --- /dev/null +++ b/services/access-control/v2/operations/create-itwin-group/displayName.md @@ -0,0 +1 @@ +Create iTwin group \ No newline at end of file diff --git a/services/access-control/v2/operations/create-itwin-job/description.md b/services/access-control/v2/operations/create-itwin-job/description.md new file mode 100644 index 0000000..fbd6cb7 --- /dev/null +++ b/services/access-control/v2/operations/create-itwin-job/description.md @@ -0,0 +1,19 @@ +--- + +Create a new iTwin job. iTwin jobs allow you to preform actions on an iTwin in bulk. + +Currently there are three types of supported actions: + +- `assignRoles` +- `unassignRoles` +- `removeMembers` + +Note: If the user being assigned roles in the `assignRoles` action is not a member of the iTwin, they will be added to the iTwin with the provided roles. + +`assignRoles` and `unassignRoles` actions have a limit of 100 roles per group of actions. `removeMembers` has a limit of 100 emails. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/create-itwin-job/displayName.md b/services/access-control/v2/operations/create-itwin-job/displayName.md new file mode 100644 index 0000000..51f8b3e --- /dev/null +++ b/services/access-control/v2/operations/create-itwin-job/displayName.md @@ -0,0 +1 @@ +Create iTwin job \ No newline at end of file diff --git a/services/access-control/v2/operations/delete-iTwin-role/description.md b/services/access-control/v2/operations/delete-iTwin-role/description.md new file mode 100644 index 0000000..92734fe --- /dev/null +++ b/services/access-control/v2/operations/delete-iTwin-role/description.md @@ -0,0 +1,9 @@ +--- + +Delete the specified iTwin role. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/delete-iTwin-role/displayName.md b/services/access-control/v2/operations/delete-iTwin-role/displayName.md new file mode 100644 index 0000000..6792532 --- /dev/null +++ b/services/access-control/v2/operations/delete-iTwin-role/displayName.md @@ -0,0 +1 @@ +Delete iTwin role \ No newline at end of file diff --git a/services/access-control/v2/operations/delete-itwin-group/description.md b/services/access-control/v2/operations/delete-itwin-group/description.md new file mode 100644 index 0000000..f0e28b7 --- /dev/null +++ b/services/access-control/v2/operations/delete-itwin-group/description.md @@ -0,0 +1,15 @@ +--- + +Delete the specified iTwin group. + +{!Authorization.md!} + +### Authorization + +A user can delete a Group by being assigned the `administration_manage_groups` on the iTwin level. A user also can delete a Group on an iTwin by either being an Organization Administrator for the Organization that owns the given iTwin, or an owner of the iTwin. + +For deletion of Groups on the Account iTwin, the user must be an Organization Administrator for the Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +--- diff --git a/services/access-control/v2/operations/delete-itwin-group/displayName.md b/services/access-control/v2/operations/delete-itwin-group/displayName.md new file mode 100644 index 0000000..2385fef --- /dev/null +++ b/services/access-control/v2/operations/delete-itwin-group/displayName.md @@ -0,0 +1 @@ +Delete iTwin group \ No newline at end of file diff --git a/services/access-control/v2/operations/get-all-permissions/description.md b/services/access-control/v2/operations/get-all-permissions/description.md new file mode 100644 index 0000000..2f8242f --- /dev/null +++ b/services/access-control/v2/operations/get-all-permissions/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves the list of all available permissions + +{!Authorization.md!} + +### Authorization + +No Authorization is required for this API call. + +--- diff --git a/services/access-control/v2/operations/get-all-permissions/displayName.md b/services/access-control/v2/operations/get-all-permissions/displayName.md new file mode 100644 index 0000000..3d98619 --- /dev/null +++ b/services/access-control/v2/operations/get-all-permissions/displayName.md @@ -0,0 +1 @@ +Get all permissions \ No newline at end of file diff --git a/services/access-control/v2/operations/get-iTwin-permissions/description.md b/services/access-control/v2/operations/get-iTwin-permissions/description.md new file mode 100644 index 0000000..5f31273 --- /dev/null +++ b/services/access-control/v2/operations/get-iTwin-permissions/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves a list of permissions the calling user has on a specified iTwin. + +{!Authorization.md!} + +### Authorization + +No Authorization is required for this API call. + +--- \ No newline at end of file diff --git a/services/access-control/v2/operations/get-iTwin-permissions/displayName.md b/services/access-control/v2/operations/get-iTwin-permissions/displayName.md new file mode 100644 index 0000000..49a6b26 --- /dev/null +++ b/services/access-control/v2/operations/get-iTwin-permissions/displayName.md @@ -0,0 +1 @@ +Get my iTwin permissions \ No newline at end of file diff --git a/services/access-control/v2/operations/get-iTwin-roles/description.md b/services/access-control/v2/operations/get-iTwin-roles/description.md new file mode 100644 index 0000000..1bb922d --- /dev/null +++ b/services/access-control/v2/operations/get-iTwin-roles/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves a list of available user roles that are defined for a specified iTwin. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/get-iTwin-roles/displayName.md b/services/access-control/v2/operations/get-iTwin-roles/displayName.md new file mode 100644 index 0000000..5192c0f --- /dev/null +++ b/services/access-control/v2/operations/get-iTwin-roles/displayName.md @@ -0,0 +1 @@ +Get iTwin roles \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-group-member/description.md b/services/access-control/v2/operations/get-itwin-group-member/description.md new file mode 100644 index 0000000..6423da3 --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-group-member/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves a specific group member for a specified iTwin. + +{!Authorization.md!} + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve an iTwin member for any iTwin in their Organization. + +{!OrganizationAdministrator.md!} + +--- diff --git a/services/access-control/v2/operations/get-itwin-group-member/displayName.md b/services/access-control/v2/operations/get-itwin-group-member/displayName.md new file mode 100644 index 0000000..e9903b7 --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-group-member/displayName.md @@ -0,0 +1 @@ +Get iTwin group member \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-group-members/description.md b/services/access-control/v2/operations/get-itwin-group-members/description.md new file mode 100644 index 0000000..438c5f6 --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-group-members/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves a list of iTwin group members and their roles assignments. + +{!Authorization.md!} + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin members for any iTwin in their Organization. + +{!OrganizationAdministrator.md!} + +--- diff --git a/services/access-control/v2/operations/get-itwin-group-members/displayName.md b/services/access-control/v2/operations/get-itwin-group-members/displayName.md new file mode 100644 index 0000000..ebfde9f --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-group-members/displayName.md @@ -0,0 +1 @@ +Get iTwin group members \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-group/description.md b/services/access-control/v2/operations/get-itwin-group/description.md new file mode 100644 index 0000000..2f8f763 --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-group/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves the specified group for the specified iTwin. The `members` and `imsGroups` properties are both capped at 50 each. + +{!Authorization.md!} + +### Authorization + +User must be an Organization Administrator for the Organization that owns the given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-group/displayName.md b/services/access-control/v2/operations/get-itwin-group/displayName.md new file mode 100644 index 0000000..9c3cb9f --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-group/displayName.md @@ -0,0 +1 @@ +Get iTwin group \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-groups/description.md b/services/access-control/v2/operations/get-itwin-groups/description.md new file mode 100644 index 0000000..479afeb --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-groups/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves a list of all groups that are defined for a specified iTwin. The `members` and `imsGroups` properties are both capped at 50 each. + +{!Authorization.md!} + +### Authorization + +User must be an Organization Administrator for the Organization that owns the given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-groups/displayName.md b/services/access-control/v2/operations/get-itwin-groups/displayName.md new file mode 100644 index 0000000..3b2c4d1 --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-groups/displayName.md @@ -0,0 +1 @@ +Get iTwin groups \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-job-actions/description.md b/services/access-control/v2/operations/get-itwin-job-actions/description.md new file mode 100644 index 0000000..6660bc9 --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-job-actions/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves the iTwin job actions for the specified iTwin job for the specified iTwin. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/get-itwin-job-actions/displayName.md b/services/access-control/v2/operations/get-itwin-job-actions/displayName.md new file mode 100644 index 0000000..6cfd93e --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-job-actions/displayName.md @@ -0,0 +1 @@ +Get iTwin job actions \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-job/description.md b/services/access-control/v2/operations/get-itwin-job/description.md new file mode 100644 index 0000000..8b58d44 --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-job/description.md @@ -0,0 +1,18 @@ +--- + +Retrieves the specified iTwin job for the specified iTwin. + +By default this operation will only return the `status` of the iTwin job. To find the specific errors of the iTwin job, include `return=representation` in the `Prefer` header. + +### Status + +- `Active`: iTwin job is stil in progress. +- `Completed`: iTwin job completed without error. +- `PartialCompleted`: iTwin job completed with some actions failing. To find the specific errors of the iTwin job, include `return=representation` in the `Prefer` header. +- `Failed`: iTwin job completed with all actions failing. To find the specific errors of the iTwin job, include `return=representation` in the `Prefer` header. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/get-itwin-job/displayName.md b/services/access-control/v2/operations/get-itwin-job/displayName.md new file mode 100644 index 0000000..3fcab99 --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-job/displayName.md @@ -0,0 +1 @@ +Get iTwin job \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-member-invitations/description.md b/services/access-control/v2/operations/get-itwin-member-invitations/description.md new file mode 100644 index 0000000..579b70c --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-member-invitations/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves a list of iTwin member invitations. By default, users will receive the invitations they have sent. If the user is an iTwin Owner, they will receive all invitations for the iTwin. + +Invitations have an expiration of 7 days after their creation. Once that expiration passes, the invitation will not be returned. + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin member invitations for any iTwin in their Organization. + +{!OrganizationAdministrator.md!} + +--- diff --git a/services/access-control/v2/operations/get-itwin-member-invitations/displayName.md b/services/access-control/v2/operations/get-itwin-member-invitations/displayName.md new file mode 100644 index 0000000..f6be40a --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-member-invitations/displayName.md @@ -0,0 +1 @@ +Get iTwin member invitations \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-owner-members/description.md b/services/access-control/v2/operations/get-itwin-owner-members/description.md new file mode 100644 index 0000000..fa5bbf9 --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-owner-members/description.md @@ -0,0 +1,34 @@ +--- + +Retrieves a list of iTwin owner members. iTwin Owners are users which have full control over the iTwin. Each owner is granted all permissions on the iTwin, allowing them to perform any action on the iTwin they own. + +### Missing Users + +When members are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a member of the iTwin. When this happens, the user member will be returned from this API endpoint with the follow values: +``` +{ + "id": , + "email": null, + "givenName": null, + "surname": null, + "organization": null, + ... +} +``` +You should account for this in your software if you do not want to show these users. + +#### Cleanup + +The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient. + +If not, you can use the [Remove iTwin Owner Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-owner-member/) API (use the memberId) to remove the owner member from the iTwin. + +{!Authorization.md!} + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin owner members for any iTwin in their Organization. + +{!OrganizationAdministrator.md!} + +--- diff --git a/services/access-control/v2/operations/get-itwin-owner-members/displayName.md b/services/access-control/v2/operations/get-itwin-owner-members/displayName.md new file mode 100644 index 0000000..bff08bc --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-owner-members/displayName.md @@ -0,0 +1 @@ +Get iTwin owner members \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-role/description.md b/services/access-control/v2/operations/get-itwin-role/description.md new file mode 100644 index 0000000..6ba0a3e --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-role/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves the specified role for the specified iTwin. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/get-itwin-role/displayName.md b/services/access-control/v2/operations/get-itwin-role/displayName.md new file mode 100644 index 0000000..234e61f --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-role/displayName.md @@ -0,0 +1 @@ +Get iTwin role \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-user-member/description.md b/services/access-control/v2/operations/get-itwin-user-member/description.md new file mode 100644 index 0000000..25c722b --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-user-member/description.md @@ -0,0 +1,34 @@ +--- + +Retrieves a specific user member for a specified iTwin. + +### Missing Users + +When users are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a user member of the iTwin. When this happens, the user member will be returned from this API endpoint with the follow values: +``` +{ + "id": , + "email": null, + "givenName": null, + "surname": null, + "organization": null, + ... +} +``` +You should account for this in your software if you do not want to show these users. + +#### Cleanup + +The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient. + +If not, you can use the [Remove iTwin User Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-user-member/) API (use the memberId) to remove the user member from the iTwin. + +{!Authorization.md!} + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve an iTwin user member for any iTwin in their Organization. + +{!OrganizationAdministrator.md!} + +--- diff --git a/services/access-control/v2/operations/get-itwin-user-member/displayName.md b/services/access-control/v2/operations/get-itwin-user-member/displayName.md new file mode 100644 index 0000000..214f53f --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-user-member/displayName.md @@ -0,0 +1 @@ +Get iTwin user member \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-user-members/description.md b/services/access-control/v2/operations/get-itwin-user-members/description.md new file mode 100644 index 0000000..032493a --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-user-members/description.md @@ -0,0 +1,34 @@ +--- + +Retrieves a list of iTwin user members and their roles assignments. + +### Missing Users + +When members are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a member of the iTwin. When this happens, the user member will be returned from this API endpoint with the follow values: +``` +{ + "id": , + "email": null, + "givenName": null, + "surname": null, + "organization": null, + ... +} +``` +You should account for this in your software if you do not want to show these users. + +#### Cleanup + +The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient. + +If not, you can use the [Remove iTwin User Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-user-member/) API (use the memberId) to remove the user member from the iTwin. + +{!Authorization.md!} + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin user members for any iTwin in their Organization. + +{!OrganizationAdministrator.md!} + +--- diff --git a/services/access-control/v2/operations/get-itwin-user-members/displayName.md b/services/access-control/v2/operations/get-itwin-user-members/displayName.md new file mode 100644 index 0000000..cafd6bd --- /dev/null +++ b/services/access-control/v2/operations/get-itwin-user-members/displayName.md @@ -0,0 +1 @@ +Get iTwin user members \ No newline at end of file diff --git a/services/access-control/v2/operations/remove-itwin-group-member/description.md b/services/access-control/v2/operations/remove-itwin-group-member/description.md new file mode 100644 index 0000000..a0be90c --- /dev/null +++ b/services/access-control/v2/operations/remove-itwin-group-member/description.md @@ -0,0 +1,9 @@ +--- + +Remove the specified group member from the iTwin. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/remove-itwin-group-member/displayName.md b/services/access-control/v2/operations/remove-itwin-group-member/displayName.md new file mode 100644 index 0000000..b8dc5e9 --- /dev/null +++ b/services/access-control/v2/operations/remove-itwin-group-member/displayName.md @@ -0,0 +1 @@ +Remove iTwin group member \ No newline at end of file diff --git a/services/access-control/v2/operations/remove-itwin-owner-member/description.md b/services/access-control/v2/operations/remove-itwin-owner-member/description.md new file mode 100644 index 0000000..02810a6 --- /dev/null +++ b/services/access-control/v2/operations/remove-itwin-owner-member/description.md @@ -0,0 +1,11 @@ +--- + +Remove the specified owner from the iTwin. + +{!Authorization.md!} + +You must be an owner to remove other owners. + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/remove-itwin-owner-member/displayName.md b/services/access-control/v2/operations/remove-itwin-owner-member/displayName.md new file mode 100644 index 0000000..a2988c9 --- /dev/null +++ b/services/access-control/v2/operations/remove-itwin-owner-member/displayName.md @@ -0,0 +1 @@ +Remove iTwin owner member \ No newline at end of file diff --git a/services/access-control/v2/operations/remove-itwin-user-member/description.md b/services/access-control/v2/operations/remove-itwin-user-member/description.md new file mode 100644 index 0000000..6009286 --- /dev/null +++ b/services/access-control/v2/operations/remove-itwin-user-member/description.md @@ -0,0 +1,9 @@ +--- + +Remove the specified user member from the iTwin. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/remove-itwin-user-member/displayName.md b/services/access-control/v2/operations/remove-itwin-user-member/displayName.md new file mode 100644 index 0000000..bb8769f --- /dev/null +++ b/services/access-control/v2/operations/remove-itwin-user-member/displayName.md @@ -0,0 +1 @@ +Remove iTwin user member \ No newline at end of file diff --git a/services/access-control/v2/operations/update-iTwin-role/description.md b/services/access-control/v2/operations/update-iTwin-role/description.md new file mode 100644 index 0000000..d2b7b60 --- /dev/null +++ b/services/access-control/v2/operations/update-iTwin-role/description.md @@ -0,0 +1,9 @@ +--- + +Update the specified iTwin role. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/update-iTwin-role/displayName.md b/services/access-control/v2/operations/update-iTwin-role/displayName.md new file mode 100644 index 0000000..8eae21f --- /dev/null +++ b/services/access-control/v2/operations/update-iTwin-role/displayName.md @@ -0,0 +1 @@ +Update iTwin role \ No newline at end of file diff --git a/services/access-control/v2/operations/update-itwin-group-member/description.md b/services/access-control/v2/operations/update-itwin-group-member/description.md new file mode 100644 index 0000000..3ec5c7f --- /dev/null +++ b/services/access-control/v2/operations/update-itwin-group-member/description.md @@ -0,0 +1,9 @@ +--- + +Update an iTwin group member's role assignments + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/update-itwin-group-member/displayName.md b/services/access-control/v2/operations/update-itwin-group-member/displayName.md new file mode 100644 index 0000000..7ffc336 --- /dev/null +++ b/services/access-control/v2/operations/update-itwin-group-member/displayName.md @@ -0,0 +1 @@ +Update iTwin group member \ No newline at end of file diff --git a/services/access-control/v2/operations/update-itwin-group/description.md b/services/access-control/v2/operations/update-itwin-group/description.md new file mode 100644 index 0000000..d021b08 --- /dev/null +++ b/services/access-control/v2/operations/update-itwin-group/description.md @@ -0,0 +1,17 @@ +--- + +Update the specified iTwin group. The `members` and `imsGroups` properties are both capped at 50 each. + +{!Authorization.md!} + +### Authorization + +A user can update a Group by being assigned the `administration_manage_groups` on the iTwin level. If the user is adding members or IMS groups they must also have the `administration_invite_member` permission assigned at the iTwin level. If the user is removing members or IMS groups they must also have the `administration_remove_member` permission assigned at the iTwin level. + +A user also can update a Group on an iTwin by either being an Organization Administrator for the Organization that owns the given iTwin, or an owner of the iTwin. + +To update a Group on the Account iTwin, the user must be an Organization Administrator for the Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page + +--- diff --git a/services/access-control/v2/operations/update-itwin-group/displayName.md b/services/access-control/v2/operations/update-itwin-group/displayName.md new file mode 100644 index 0000000..337cbad --- /dev/null +++ b/services/access-control/v2/operations/update-itwin-group/displayName.md @@ -0,0 +1 @@ +Update iTwin group \ No newline at end of file diff --git a/services/access-control/v2/operations/update-itwin-user-member/description.md b/services/access-control/v2/operations/update-itwin-user-member/description.md new file mode 100644 index 0000000..e7e6f8e --- /dev/null +++ b/services/access-control/v2/operations/update-itwin-user-member/description.md @@ -0,0 +1,9 @@ +--- + +Update an iTwin user member's role assignments + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +--- diff --git a/services/access-control/v2/operations/update-itwin-user-member/displayName.md b/services/access-control/v2/operations/update-itwin-user-member/displayName.md new file mode 100644 index 0000000..9bee9bb --- /dev/null +++ b/services/access-control/v2/operations/update-itwin-user-member/displayName.md @@ -0,0 +1 @@ +Update iTwin user member \ No newline at end of file diff --git a/services/carbon-calculation/v1/description.md b/services/carbon-calculation/v1/description.md new file mode 100644 index 0000000..0bb21d0 --- /dev/null +++ b/services/carbon-calculation/v1/description.md @@ -0,0 +1 @@ +Access iTwin data integrations with Carbon Calculation solutions for Embodied Carbon, Life Cycle Assessments, and more. \ No newline at end of file diff --git a/services/carbon-calculation/v1/operations/create-ec3-configuration/description.md b/services/carbon-calculation/v1/operations/create-ec3-configuration/description.md new file mode 100644 index 0000000..0733d9e --- /dev/null +++ b/services/carbon-calculation/v1/operations/create-ec3-configuration/description.md @@ -0,0 +1,11 @@ +--- + +Create EC3 upload configuration. + +{!EC3.md!} + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +--- diff --git a/services/carbon-calculation/v1/operations/create-ec3-configuration/displayName.md b/services/carbon-calculation/v1/operations/create-ec3-configuration/displayName.md new file mode 100644 index 0000000..4ec379a --- /dev/null +++ b/services/carbon-calculation/v1/operations/create-ec3-configuration/displayName.md @@ -0,0 +1 @@ +Create EC3 Configuration \ No newline at end of file diff --git a/services/carbon-calculation/v1/operations/create-ec3-job/description.md b/services/carbon-calculation/v1/operations/create-ec3-job/description.md new file mode 100644 index 0000000..5b1cebb --- /dev/null +++ b/services/carbon-calculation/v1/operations/create-ec3-job/description.md @@ -0,0 +1,11 @@ +--- + +Uploads report data to EC3. + +{!EC3.md!} + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +--- diff --git a/services/carbon-calculation/v1/operations/create-ec3-job/displayName.md b/services/carbon-calculation/v1/operations/create-ec3-job/displayName.md new file mode 100644 index 0000000..904975c --- /dev/null +++ b/services/carbon-calculation/v1/operations/create-ec3-job/displayName.md @@ -0,0 +1 @@ +Create EC3 Job \ No newline at end of file diff --git a/services/carbon-calculation/v1/operations/create-oneclicklca-job/description.md b/services/carbon-calculation/v1/operations/create-oneclicklca-job/description.md new file mode 100644 index 0000000..e821526 --- /dev/null +++ b/services/carbon-calculation/v1/operations/create-oneclicklca-job/description.md @@ -0,0 +1,11 @@ +--- + +Uploads report data to One Click LCA. + +{!OneClickLCA.md!} + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +--- diff --git a/services/carbon-calculation/v1/operations/create-oneclicklca-job/displayName.md b/services/carbon-calculation/v1/operations/create-oneclicklca-job/displayName.md new file mode 100644 index 0000000..e74933b --- /dev/null +++ b/services/carbon-calculation/v1/operations/create-oneclicklca-job/displayName.md @@ -0,0 +1 @@ +Create One Click LCA job \ No newline at end of file diff --git a/services/carbon-calculation/v1/operations/delete-ec3-configuration/description.md b/services/carbon-calculation/v1/operations/delete-ec3-configuration/description.md new file mode 100644 index 0000000..f4c2690 --- /dev/null +++ b/services/carbon-calculation/v1/operations/delete-ec3-configuration/description.md @@ -0,0 +1,11 @@ +--- + +Delete EC3 upload configuration. + +{!EC3.md!} + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +--- diff --git a/services/carbon-calculation/v1/operations/delete-ec3-configuration/displayName.md b/services/carbon-calculation/v1/operations/delete-ec3-configuration/displayName.md new file mode 100644 index 0000000..2fe65ee --- /dev/null +++ b/services/carbon-calculation/v1/operations/delete-ec3-configuration/displayName.md @@ -0,0 +1 @@ +Delete EC3 Configuration \ No newline at end of file diff --git a/services/carbon-calculation/v1/operations/get-ec3-configuration/description.md b/services/carbon-calculation/v1/operations/get-ec3-configuration/description.md new file mode 100644 index 0000000..8b3216d --- /dev/null +++ b/services/carbon-calculation/v1/operations/get-ec3-configuration/description.md @@ -0,0 +1,11 @@ +--- + +Get EC3 upload configuration. + +{!EC3.md!} + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +--- diff --git a/services/carbon-calculation/v1/operations/get-ec3-configuration/displayName.md b/services/carbon-calculation/v1/operations/get-ec3-configuration/displayName.md new file mode 100644 index 0000000..e501131 --- /dev/null +++ b/services/carbon-calculation/v1/operations/get-ec3-configuration/displayName.md @@ -0,0 +1 @@ +Get EC3 Configuration \ No newline at end of file diff --git a/services/carbon-calculation/v1/operations/get-ec3-configurations/description.md b/services/carbon-calculation/v1/operations/get-ec3-configurations/description.md new file mode 100644 index 0000000..132e904 --- /dev/null +++ b/services/carbon-calculation/v1/operations/get-ec3-configurations/description.md @@ -0,0 +1,11 @@ +--- + +Get EC3 upload configurations. + +{!EC3.md!} + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +--- diff --git a/services/carbon-calculation/v1/operations/get-ec3-configurations/displayName.md b/services/carbon-calculation/v1/operations/get-ec3-configurations/displayName.md new file mode 100644 index 0000000..db65235 --- /dev/null +++ b/services/carbon-calculation/v1/operations/get-ec3-configurations/displayName.md @@ -0,0 +1 @@ +Get EC3 Configurations \ No newline at end of file diff --git a/services/carbon-calculation/v1/operations/get-ec3-job-status/description.md b/services/carbon-calculation/v1/operations/get-ec3-job-status/description.md new file mode 100644 index 0000000..b814f5b --- /dev/null +++ b/services/carbon-calculation/v1/operations/get-ec3-job-status/description.md @@ -0,0 +1,11 @@ +--- + +Queries EC3 upload job status. + +{!EC3.md!} + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +--- diff --git a/services/carbon-calculation/v1/operations/get-ec3-job-status/displayName.md b/services/carbon-calculation/v1/operations/get-ec3-job-status/displayName.md new file mode 100644 index 0000000..7f908aa --- /dev/null +++ b/services/carbon-calculation/v1/operations/get-ec3-job-status/displayName.md @@ -0,0 +1 @@ +Get EC3 Job Status \ No newline at end of file diff --git a/services/carbon-calculation/v1/operations/get-oneclicklca-job-status/description.md b/services/carbon-calculation/v1/operations/get-oneclicklca-job-status/description.md new file mode 100644 index 0000000..abe3c4a --- /dev/null +++ b/services/carbon-calculation/v1/operations/get-oneclicklca-job-status/description.md @@ -0,0 +1,11 @@ +--- + +Queries One Click LCA job status. + +{!OneClickLCA.md!} + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +--- diff --git a/services/carbon-calculation/v1/operations/get-oneclicklca-job-status/displayName.md b/services/carbon-calculation/v1/operations/get-oneclicklca-job-status/displayName.md new file mode 100644 index 0000000..43a7aaa --- /dev/null +++ b/services/carbon-calculation/v1/operations/get-oneclicklca-job-status/displayName.md @@ -0,0 +1 @@ +Get One Click LCA job status \ No newline at end of file diff --git a/services/carbon-calculation/v1/operations/update-ec3-configuration/description.md b/services/carbon-calculation/v1/operations/update-ec3-configuration/description.md new file mode 100644 index 0000000..1ac2e44 --- /dev/null +++ b/services/carbon-calculation/v1/operations/update-ec3-configuration/description.md @@ -0,0 +1,11 @@ +--- + +Update EC3 upload configuration. + +{!EC3.md!} + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +--- diff --git a/services/carbon-calculation/v1/operations/update-ec3-configuration/displayName.md b/services/carbon-calculation/v1/operations/update-ec3-configuration/displayName.md new file mode 100644 index 0000000..3cfa6aa --- /dev/null +++ b/services/carbon-calculation/v1/operations/update-ec3-configuration/displayName.md @@ -0,0 +1 @@ +Update EC3 Configuration \ No newline at end of file diff --git a/services/changed-elements/v2/description.md b/services/changed-elements/v2/description.md new file mode 100644 index 0000000..8a9d794 --- /dev/null +++ b/services/changed-elements/v2/description.md @@ -0,0 +1,11 @@ +# Changed Elements + +The Changed Elements API provides consumers with the elements that have changed in an iModel between two changesets. + +Operations Include: + +- [Create Comparison Job](operations/create-comparison-job/) Creates a comparison. The comparison will be queued when first created and will progress to completion. When completed, it will contain all the comparison info. Use [Get Comparison Job](operations/get-comparison-job/) for information on comparison. + +- [Delete Comparison Job](operations/delete-comparison-job/) Deletes all stored data relating to comparison. + +- [Get Comparison Job](operations/get-comparison-job/) Gets comparison based on the job id. The comparison will contain the job status, start and end changeset ids, and comparison progress. If the comparison is complete, the response will also include a href to the comparison information. diff --git a/services/changed-elements/v2/operations/create-comparison-job/description.md b/services/changed-elements/v2/operations/create-comparison-job/description.md new file mode 100644 index 0000000..81eabf9 --- /dev/null +++ b/services/changed-elements/v2/operations/create-comparison-job/description.md @@ -0,0 +1,13 @@ +--- + +### Job Creation + +Creates a comparison job. The comparison will be queued when first created and will progress to completion. When completed, you can use [Get Comparison Job](operations/get-comparison-job/) to query the results. + +### Webhooks + +Once a job is finished, an event is triggered via the [Webhooks API](https://developer.bentley.com/apis/webhooks-v2/overview/). All subscribers of the [changeElements.jobCompleted.v1](https://developer.bentley.com/apis/webhooks-v2/available-events/#Changed%20Elements-events-ref) event type will be notified. + +{!Authorization.md!} + +--- diff --git a/services/changed-elements/v2/operations/create-comparison-job/displayName.md b/services/changed-elements/v2/operations/create-comparison-job/displayName.md new file mode 100644 index 0000000..a740f48 --- /dev/null +++ b/services/changed-elements/v2/operations/create-comparison-job/displayName.md @@ -0,0 +1 @@ +Create Comparison Job \ No newline at end of file diff --git a/services/changed-elements/v2/operations/delete-comparison-job/description.md b/services/changed-elements/v2/operations/delete-comparison-job/description.md new file mode 100644 index 0000000..37be8f1 --- /dev/null +++ b/services/changed-elements/v2/operations/delete-comparison-job/description.md @@ -0,0 +1,9 @@ +--- + +Deletes based on the job Id, iTwin Id, and iModel Id. All stored data relating to comparison will be deleted. + +Job Id: is normally comprised of start changeset id and end changeset id, in the following format: {startChangesetId}-{endChangesetId} + +{!Authorization.md!} + +--- diff --git a/services/changed-elements/v2/operations/delete-comparison-job/displayName.md b/services/changed-elements/v2/operations/delete-comparison-job/displayName.md new file mode 100644 index 0000000..dea7959 --- /dev/null +++ b/services/changed-elements/v2/operations/delete-comparison-job/displayName.md @@ -0,0 +1 @@ +Delete Comparison Job \ No newline at end of file diff --git a/services/changed-elements/v2/operations/get-comparison-job/description.md b/services/changed-elements/v2/operations/get-comparison-job/description.md new file mode 100644 index 0000000..c075dd1 --- /dev/null +++ b/services/changed-elements/v2/operations/get-comparison-job/description.md @@ -0,0 +1,41 @@ +--- + +Gets comparison based on the job Id, iTwin Id, and iModel Id. The comparison will contain the job status, start and end changeset ids, and comparison progress. If the comparison is complete, the response will also include an href to the comparison information. + +Job Id: is normally comprised of start changeset id and end changeset id, in the following format: {startChangesetId}-{endChangesetId} + +### Understanding Change + +The comparison job blob, which can be downloaded using the provided link, includes a [ChangedElements](https://www.itwinjs.org/reference/core-common/entities/changedelements/) object. This object comprises several arrays of identical size. Each element across these arrays is identified by a unique index. +map + +Here are some key arrays that provide insights into the modifications made to an element: + +**opcodes**: This array stores operation codes that indicate whether an element was inserted, updated, or deleted during the change. For more details, refer to [DbOpcode](https://www.itwinjs.org/reference/core-bentley/besqlite/dbopcode/). The relevant values are outlined below: + +| Opcode | Description | +|:------:|-----------| +| 9 | Element was deleted | +| 23 | Element was modified | +| 18 | Element was inserted | + +  +  + +**type**: Contains the type of change that occurred to the element. This number is a bit-flag and can be used to know whether the element had property changes, geometric changes, placement changes, indirect changes, and hidden property changes. See [TypeOfChange](https://www.itwinjs.org/reference/core-common/entities/typeofchange/) for more information. Below is a table with the values and their meaning: + +| Type | Value | Description | +|------|:-----:|-------------| +| Property | 1 | A property in the element changed | +| Geometry | 2 | The geometry of the element changed | +| Placement | 4 | The placement of the element changed. This means that the element changed its volume, origin or rotation. | +| Indirect | 8 | Indirect change occurred to this element by a related instance that provides properties for it | +| Hidden | 16 | Hidden properties of the element changed | +| Parent | 32 | The top-most parent of the element has changed | + +### Prefer Header + +You may set the `Prefer` header as `return=minimal` if you want to skip all data related to element properties. + +{!Authorization.md!} +--- diff --git a/services/changed-elements/v2/operations/get-comparison-job/displayName.md b/services/changed-elements/v2/operations/get-comparison-job/displayName.md new file mode 100644 index 0000000..18dd803 --- /dev/null +++ b/services/changed-elements/v2/operations/get-comparison-job/displayName.md @@ -0,0 +1 @@ +Get Comparison Job \ No newline at end of file diff --git a/services/clash-detection/v2/description.md b/services/clash-detection/v2/description.md new file mode 100644 index 0000000..b82a5fe --- /dev/null +++ b/services/clash-detection/v2/description.md @@ -0,0 +1 @@ +The Clash Detection API allows you to manage clash detection suppression rules, tests, runs, results and manual suppression. \ No newline at end of file diff --git a/services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/description.md b/services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/description.md new file mode 100644 index 0000000..73363ab --- /dev/null +++ b/services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/description.md @@ -0,0 +1,11 @@ +--- + +Applies the clash detection manual suppression. + +- Discover result id (Clash-report-id) by calling [GET /clashdetection/results](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-results/) + +- Discover pairs of element ids which are clashing by calling [GET /clashdetection/results/{id}](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-result/) + +{!Authorization.md!} + +--- diff --git a/services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/displayName.md b/services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/displayName.md new file mode 100644 index 0000000..0178099 --- /dev/null +++ b/services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/displayName.md @@ -0,0 +1 @@ +Apply clash detection manual suppression \ No newline at end of file diff --git a/services/clash-detection/v2/operations/cancel-clashdetection-run/description.md b/services/clash-detection/v2/operations/cancel-clashdetection-run/description.md new file mode 100644 index 0000000..714360d --- /dev/null +++ b/services/clash-detection/v2/operations/cancel-clashdetection-run/description.md @@ -0,0 +1,9 @@ +--- + +Cancel the clash detection run for the specified run id (result id) of the respective iTwin. Currently only one run id (result id) can be cancelled. + +- Discover run id (result id) by calling [GET /clashdetection/results](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-results/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/clash-detection/v2/operations/cancel-clashdetection-run/displayName.md b/services/clash-detection/v2/operations/cancel-clashdetection-run/displayName.md new file mode 100644 index 0000000..2d96e6c --- /dev/null +++ b/services/clash-detection/v2/operations/cancel-clashdetection-run/displayName.md @@ -0,0 +1 @@ +Cancel clash detection run \ No newline at end of file diff --git a/services/clash-detection/v2/operations/create-clashdetection-suppression-rule/description.md b/services/clash-detection/v2/operations/create-clashdetection-suppression-rule/description.md new file mode 100644 index 0000000..ef1f6c4 --- /dev/null +++ b/services/clash-detection/v2/operations/create-clashdetection-suppression-rule/description.md @@ -0,0 +1,9 @@ +--- + +Creates a clash detection suppression rule for the specified criteria and returns the rule id. + +- Discover rule template ids by calling [GET /clashdetection/suppressionRuleTemplates](/api-groups/validation/apis/clash-detection/operations/get-suppression-rule-templates/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/clash-detection/v2/operations/create-clashdetection-suppression-rule/displayName.md b/services/clash-detection/v2/operations/create-clashdetection-suppression-rule/displayName.md new file mode 100644 index 0000000..4d80262 --- /dev/null +++ b/services/clash-detection/v2/operations/create-clashdetection-suppression-rule/displayName.md @@ -0,0 +1 @@ +Create clash detection suppression rule \ No newline at end of file diff --git a/services/clash-detection/v2/operations/create-clashdetection-tests/description.md b/services/clash-detection/v2/operations/create-clashdetection-tests/description.md new file mode 100644 index 0000000..4497ffa --- /dev/null +++ b/services/clash-detection/v2/operations/create-clashdetection-tests/description.md @@ -0,0 +1,11 @@ +--- + +Creates clash detection test for the specified criteria and returns the test id. + +- Note: ConfigType, Set it to 2 for create clash detection test API. + +- Discover rule ids by calling [GET /clashdetection/suppressionrules](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-suppression-rules/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/clash-detection/v2/operations/create-clashdetection-tests/displayName.md b/services/clash-detection/v2/operations/create-clashdetection-tests/displayName.md new file mode 100644 index 0000000..fe346ba --- /dev/null +++ b/services/clash-detection/v2/operations/create-clashdetection-tests/displayName.md @@ -0,0 +1 @@ +Create clash detection tests \ No newline at end of file diff --git a/services/clash-detection/v2/operations/delete-clashdetection-run/description.md b/services/clash-detection/v2/operations/delete-clashdetection-run/description.md new file mode 100644 index 0000000..417c425 --- /dev/null +++ b/services/clash-detection/v2/operations/delete-clashdetection-run/description.md @@ -0,0 +1,10 @@ +--- + +Delete the clash detection run for the specified run id (result id) of the respective iTwin. +Currently only one run id (result id) can be deleted. + +- Discover run id (result id) by calling [GET /clashdetection/results](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-results/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/clash-detection/v2/operations/delete-clashdetection-run/displayName.md b/services/clash-detection/v2/operations/delete-clashdetection-run/displayName.md new file mode 100644 index 0000000..a1e7240 --- /dev/null +++ b/services/clash-detection/v2/operations/delete-clashdetection-run/displayName.md @@ -0,0 +1 @@ +Delete clash detection run \ No newline at end of file diff --git a/services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/description.md b/services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/description.md new file mode 100644 index 0000000..38af296 --- /dev/null +++ b/services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/description.md @@ -0,0 +1,9 @@ +--- + +Deletes the clash detection suppression rule for the specified rule id. + +- Discover rule ids by calling [GET /clashdetection/suppressionrules](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-suppression-rules/) + +{!Authorization.md!} + +--- diff --git a/services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/displayName.md b/services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/displayName.md new file mode 100644 index 0000000..588d55d --- /dev/null +++ b/services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/displayName.md @@ -0,0 +1 @@ +Delete clash detection suppression rule \ No newline at end of file diff --git a/services/clash-detection/v2/operations/delete-clashdetection-test/description.md b/services/clash-detection/v2/operations/delete-clashdetection-test/description.md new file mode 100644 index 0000000..b3837c0 --- /dev/null +++ b/services/clash-detection/v2/operations/delete-clashdetection-test/description.md @@ -0,0 +1,9 @@ +--- + +Deletes the clash detection test for the specified test id. + +- Discover test ids by calling [GET /clashdetection/tests](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-tests/) + +{!Authorization.md!} + +--- diff --git a/services/clash-detection/v2/operations/delete-clashdetection-test/displayName.md b/services/clash-detection/v2/operations/delete-clashdetection-test/displayName.md new file mode 100644 index 0000000..0a6a870 --- /dev/null +++ b/services/clash-detection/v2/operations/delete-clashdetection-test/displayName.md @@ -0,0 +1 @@ +Delete clash detection test \ No newline at end of file diff --git a/services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/description.md b/services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/description.md new file mode 100644 index 0000000..de27979 --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/description.md @@ -0,0 +1,9 @@ +--- + +Gets the clash detection manual suppression for specified result id (Clash-report-id). + +- Discover result id (Clash-report-id) by calling [GET /clashdetection/results](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-results/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/displayName.md b/services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/displayName.md new file mode 100644 index 0000000..5bec355 --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/displayName.md @@ -0,0 +1 @@ +Get clash detection manual suppression \ No newline at end of file diff --git a/services/clash-detection/v2/operations/get-clashdetection-result/description.md b/services/clash-detection/v2/operations/get-clashdetection-result/description.md new file mode 100644 index 0000000..3d50e2d --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-result/description.md @@ -0,0 +1,9 @@ +--- + +Gets the clash detection result details for the specified result id. + +- Discover result ids by calling [GET /clashdetection/results](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-results/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/clash-detection/v2/operations/get-clashdetection-result/displayName.md b/services/clash-detection/v2/operations/get-clashdetection-result/displayName.md new file mode 100644 index 0000000..3a5a4ed --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-result/displayName.md @@ -0,0 +1 @@ +Get clash detection result details \ No newline at end of file diff --git a/services/clash-detection/v2/operations/get-clashdetection-results/description.md b/services/clash-detection/v2/operations/get-clashdetection-results/description.md new file mode 100644 index 0000000..2c1650b --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-results/description.md @@ -0,0 +1,7 @@ +--- + +Gets the clash detection results for the specified iTwin id. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/clash-detection/v2/operations/get-clashdetection-results/displayName.md b/services/clash-detection/v2/operations/get-clashdetection-results/displayName.md new file mode 100644 index 0000000..c048a7a --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-results/displayName.md @@ -0,0 +1 @@ +Get clash detection results \ No newline at end of file diff --git a/services/clash-detection/v2/operations/get-clashdetection-suppression-rule/description.md b/services/clash-detection/v2/operations/get-clashdetection-suppression-rule/description.md new file mode 100644 index 0000000..ea4380d --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-suppression-rule/description.md @@ -0,0 +1,9 @@ +--- + +Gets the clash detection suppression rule details for the specified rule id. + +- Discover rule ids by calling [GET /clashdetection/r](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-suppression-rules/) + +{!Authorization.md!} + +--- diff --git a/services/clash-detection/v2/operations/get-clashdetection-suppression-rule/displayName.md b/services/clash-detection/v2/operations/get-clashdetection-suppression-rule/displayName.md new file mode 100644 index 0000000..fbcc862 --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-suppression-rule/displayName.md @@ -0,0 +1 @@ +Get clash detection suppression rule \ No newline at end of file diff --git a/services/clash-detection/v2/operations/get-clashdetection-suppression-rules/description.md b/services/clash-detection/v2/operations/get-clashdetection-suppression-rules/description.md new file mode 100644 index 0000000..42053f0 --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-suppression-rules/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves the list of clash detection suppression rules for the iTwin id. + +{!Authorization.md!} + +--- diff --git a/services/clash-detection/v2/operations/get-clashdetection-suppression-rules/displayName.md b/services/clash-detection/v2/operations/get-clashdetection-suppression-rules/displayName.md new file mode 100644 index 0000000..420c572 --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-suppression-rules/displayName.md @@ -0,0 +1 @@ +Get clash detection suppression rules \ No newline at end of file diff --git a/services/clash-detection/v2/operations/get-clashdetection-test/description.md b/services/clash-detection/v2/operations/get-clashdetection-test/description.md new file mode 100644 index 0000000..98ca5a2 --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-test/description.md @@ -0,0 +1,9 @@ +--- + +Gets the clash detection test details for the specified test id. + +- Discover test ids by calling [GET /clashdetection/tests](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-tests/) + +{!Authorization.md!} + +--- diff --git a/services/clash-detection/v2/operations/get-clashdetection-test/displayName.md b/services/clash-detection/v2/operations/get-clashdetection-test/displayName.md new file mode 100644 index 0000000..da14653 --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-test/displayName.md @@ -0,0 +1 @@ +Get clash detection test details \ No newline at end of file diff --git a/services/clash-detection/v2/operations/get-clashdetection-tests/description.md b/services/clash-detection/v2/operations/get-clashdetection-tests/description.md new file mode 100644 index 0000000..a092fb2 --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-tests/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves a list of Clash Detection tests for the project specified by the iTwin id. + +### Notes + +{!Authorization.md!} + +--- diff --git a/services/clash-detection/v2/operations/get-clashdetection-tests/displayName.md b/services/clash-detection/v2/operations/get-clashdetection-tests/displayName.md new file mode 100644 index 0000000..ba010f0 --- /dev/null +++ b/services/clash-detection/v2/operations/get-clashdetection-tests/displayName.md @@ -0,0 +1 @@ +Get clash detection tests \ No newline at end of file diff --git a/services/clash-detection/v2/operations/get-suppression-rule-templates/description.md b/services/clash-detection/v2/operations/get-suppression-rule-templates/description.md new file mode 100644 index 0000000..cb9ee26 --- /dev/null +++ b/services/clash-detection/v2/operations/get-suppression-rule-templates/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a list of Clash Detection suppression rule templates for the project specified by the iTwin id. + +{!Authorization.md!} + +--- diff --git a/services/clash-detection/v2/operations/get-suppression-rule-templates/displayName.md b/services/clash-detection/v2/operations/get-suppression-rule-templates/displayName.md new file mode 100644 index 0000000..c76c87c --- /dev/null +++ b/services/clash-detection/v2/operations/get-suppression-rule-templates/displayName.md @@ -0,0 +1 @@ +Get suppression rule templates \ No newline at end of file diff --git a/services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/description.md b/services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/description.md new file mode 100644 index 0000000..7deea06 --- /dev/null +++ b/services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/description.md @@ -0,0 +1,11 @@ +--- + +Removes the clash detection manual suppression. + +- Discover result id (Clash-report-id) by calling [GET /clashdetection/results](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-results/)y + +- Discover pairs of element ids which are manually suppressed by calling [GET /clashdetection//manualsuppressionrules](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-manual-suppression-rules/) + +{!Authorization.md!} + +--- diff --git a/services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/displayName.md b/services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/displayName.md new file mode 100644 index 0000000..7775934 --- /dev/null +++ b/services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/displayName.md @@ -0,0 +1 @@ +Remove clash detection manual suppression \ No newline at end of file diff --git a/services/clash-detection/v2/operations/run-clashdetection-test/description.md b/services/clash-detection/v2/operations/run-clashdetection-test/description.md new file mode 100644 index 0000000..aded189 --- /dev/null +++ b/services/clash-detection/v2/operations/run-clashdetection-test/description.md @@ -0,0 +1,17 @@ +--- + +Runs Clash Detection test for the specified test ids (currently restricted to 1 test run per request) and returns the result/clash-report ids. The maximum number of clashes may be specified with the resultsLimit parameter in the request body. If none is specified, the default is 100,000. + +- This API has a rate limit of 6 API calls per second. If an application exceeds the rate limit it will receive an HTTP error code 429 "Too Many Requests". The error response includes a Retry-After header that indicates how long clients should wait before retrying. + +- To retrieve the run status as the agent job completes asynchronously, use the result id to call [GET /clashdetection/results](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-result/) + +- Discover test ids by calling [GET /clashdetection/tests](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-tests/) + +- Discover iModel ids by calling [GET /imodels](/api-groups/data-management/apis/imodels-v2/operations/get-project-imodels/) + +- Discover changeset ids by calling [GET /imodels/{id}/namedversions](/api-groups/data-management/apis/imodels-v2/operations/get-imodel-changesets/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/clash-detection/v2/operations/run-clashdetection-test/displayName.md b/services/clash-detection/v2/operations/run-clashdetection-test/displayName.md new file mode 100644 index 0000000..c04fdf2 --- /dev/null +++ b/services/clash-detection/v2/operations/run-clashdetection-test/displayName.md @@ -0,0 +1 @@ +Run clash detection tests \ No newline at end of file diff --git a/services/clash-detection/v2/operations/update-clashdetection-suppression-rule/description.md b/services/clash-detection/v2/operations/update-clashdetection-suppression-rule/description.md new file mode 100644 index 0000000..371ef78 --- /dev/null +++ b/services/clash-detection/v2/operations/update-clashdetection-suppression-rule/description.md @@ -0,0 +1,9 @@ +--- + +Updates a clash detection suppression rule for the specified criteria and returns the id and details of the successfully updated rule. + +- Discover rule ids by calling [GET /clashdetection/suppressionrules](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-suppression-rules/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/clash-detection/v2/operations/update-clashdetection-suppression-rule/displayName.md b/services/clash-detection/v2/operations/update-clashdetection-suppression-rule/displayName.md new file mode 100644 index 0000000..88e40c9 --- /dev/null +++ b/services/clash-detection/v2/operations/update-clashdetection-suppression-rule/displayName.md @@ -0,0 +1 @@ +Update clash detection suppression rule \ No newline at end of file diff --git a/services/clash-detection/v2/operations/update-clashdetection-test/description.md b/services/clash-detection/v2/operations/update-clashdetection-test/description.md new file mode 100644 index 0000000..ec9377f --- /dev/null +++ b/services/clash-detection/v2/operations/update-clashdetection-test/description.md @@ -0,0 +1,14 @@ +--- + +Updates a clash detection test for the specified criteria and returns the id of the successfully updated test. + +- Note: If Tag details are not provided to a Tagged Test then it will be un-tagged. +- Note: ConfigType, Set it to 2 for clash detection update test API. + +- Discover test ids by calling [GET /clashdetection/tests](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-tests/) + +- Discover rule ids by calling [GET /clashdetection/suppressionrules](/api-groups/validation/apis/clash-detection/operations/get-clashdetection-suppression-rules/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/clash-detection/v2/operations/update-clashdetection-test/displayName.md b/services/clash-detection/v2/operations/update-clashdetection-test/displayName.md new file mode 100644 index 0000000..55da2fb --- /dev/null +++ b/services/clash-detection/v2/operations/update-clashdetection-test/displayName.md @@ -0,0 +1 @@ +Update clash detection test \ No newline at end of file diff --git a/services/contextcapture/v1/description.md b/services/contextcapture/v1/description.md new file mode 100644 index 0000000..7ee55fa --- /dev/null +++ b/services/contextcapture/v1/description.md @@ -0,0 +1,3 @@ +Interact with your jobs and workspaces for Reality Modeling + +Create, update, delete jobs and workspaces. \ No newline at end of file diff --git a/services/contextcapture/v1/operations/jobs-create/description.md b/services/contextcapture/v1/operations/jobs-create/description.md new file mode 100644 index 0000000..f51bb3c --- /dev/null +++ b/services/contextcapture/v1/operations/jobs-create/description.md @@ -0,0 +1,7 @@ +--- + +Create a new job + +{!Authorization.md!} + +--- diff --git a/services/contextcapture/v1/operations/jobs-create/displayName.md b/services/contextcapture/v1/operations/jobs-create/displayName.md new file mode 100644 index 0000000..4d15e34 --- /dev/null +++ b/services/contextcapture/v1/operations/jobs-create/displayName.md @@ -0,0 +1 @@ +Create a job \ No newline at end of file diff --git a/services/contextcapture/v1/operations/jobs-delete/description.md b/services/contextcapture/v1/operations/jobs-delete/description.md new file mode 100644 index 0000000..7ccd3bf --- /dev/null +++ b/services/contextcapture/v1/operations/jobs-delete/description.md @@ -0,0 +1,7 @@ +--- + +Delete an unsubmitted job + +{!Authorization.md!} + +--- diff --git a/services/contextcapture/v1/operations/jobs-delete/displayName.md b/services/contextcapture/v1/operations/jobs-delete/displayName.md new file mode 100644 index 0000000..99567ff --- /dev/null +++ b/services/contextcapture/v1/operations/jobs-delete/displayName.md @@ -0,0 +1 @@ +Delete a job \ No newline at end of file diff --git a/services/contextcapture/v1/operations/jobs-get/description.md b/services/contextcapture/v1/operations/jobs-get/description.md new file mode 100644 index 0000000..e89e99e --- /dev/null +++ b/services/contextcapture/v1/operations/jobs-get/description.md @@ -0,0 +1,11 @@ +--- + +Retrieve job details. + +### Parameters + +The job id + +{!Authorization.md!} + +--- diff --git a/services/contextcapture/v1/operations/jobs-get/displayName.md b/services/contextcapture/v1/operations/jobs-get/displayName.md new file mode 100644 index 0000000..9dbadf1 --- /dev/null +++ b/services/contextcapture/v1/operations/jobs-get/displayName.md @@ -0,0 +1 @@ +Get a job \ No newline at end of file diff --git a/services/contextcapture/v1/operations/jobs-patch/description.md b/services/contextcapture/v1/operations/jobs-patch/description.md new file mode 100644 index 0000000..3f86999 --- /dev/null +++ b/services/contextcapture/v1/operations/jobs-patch/description.md @@ -0,0 +1,7 @@ +--- + +Patch a job to modify it (type, settings, cost estimation parameters), submit or cancel it. + +{!Authorization.md!} + +--- diff --git a/services/contextcapture/v1/operations/jobs-patch/displayName.md b/services/contextcapture/v1/operations/jobs-patch/displayName.md new file mode 100644 index 0000000..04ae730 --- /dev/null +++ b/services/contextcapture/v1/operations/jobs-patch/displayName.md @@ -0,0 +1 @@ +Patch a job \ No newline at end of file diff --git a/services/contextcapture/v1/operations/jobs-progress/description.md b/services/contextcapture/v1/operations/jobs-progress/description.md new file mode 100644 index 0000000..ffb5ab3 --- /dev/null +++ b/services/contextcapture/v1/operations/jobs-progress/description.md @@ -0,0 +1,17 @@ +--- + +Retrieve job progress. + +### Parameters + +The job id + +### Remarks + +The job progression is deemed valid when the job is active and won't be available after 30 days. + +Client should query with a backoff intervals [15,30,60,120] seconds. The interval between the first and second query is 15 sec and then 30 sec... If the percentage changes the sequence is restarted. + +{!Authorization.md!} + +--- diff --git a/services/contextcapture/v1/operations/jobs-progress/displayName.md b/services/contextcapture/v1/operations/jobs-progress/displayName.md new file mode 100644 index 0000000..398686e --- /dev/null +++ b/services/contextcapture/v1/operations/jobs-progress/displayName.md @@ -0,0 +1 @@ +Get job progress \ No newline at end of file diff --git a/services/contextcapture/v1/operations/limits-engines/description.md b/services/contextcapture/v1/operations/limits-engines/description.md new file mode 100644 index 0000000..bd646f6 --- /dev/null +++ b/services/contextcapture/v1/operations/limits-engines/description.md @@ -0,0 +1,11 @@ +--- + +Retrieve the engines limit. + +### Parameters + +An optional projectId. + +{!Authorization.md!} + +--- diff --git a/services/contextcapture/v1/operations/limits-engines/displayName.md b/services/contextcapture/v1/operations/limits-engines/displayName.md new file mode 100644 index 0000000..1dcae2b --- /dev/null +++ b/services/contextcapture/v1/operations/limits-engines/displayName.md @@ -0,0 +1 @@ +Get engines limit \ No newline at end of file diff --git a/services/contextcapture/v1/operations/workspaces-create/description.md b/services/contextcapture/v1/operations/workspaces-create/description.md new file mode 100644 index 0000000..3776315 --- /dev/null +++ b/services/contextcapture/v1/operations/workspaces-create/description.md @@ -0,0 +1,7 @@ +--- + +Create a new workspace + +{!Authorization.md!} + +--- diff --git a/services/contextcapture/v1/operations/workspaces-create/displayName.md b/services/contextcapture/v1/operations/workspaces-create/displayName.md new file mode 100644 index 0000000..a9b67ad --- /dev/null +++ b/services/contextcapture/v1/operations/workspaces-create/displayName.md @@ -0,0 +1 @@ +Create a workspace \ No newline at end of file diff --git a/services/contextcapture/v1/operations/workspaces-delete/description.md b/services/contextcapture/v1/operations/workspaces-delete/description.md new file mode 100644 index 0000000..cc695ef --- /dev/null +++ b/services/contextcapture/v1/operations/workspaces-delete/description.md @@ -0,0 +1,11 @@ +--- + +Delete a workspace. + +### Parameters + +A workspace id. + +{!Authorization.md!} + +--- diff --git a/services/contextcapture/v1/operations/workspaces-delete/displayName.md b/services/contextcapture/v1/operations/workspaces-delete/displayName.md new file mode 100644 index 0000000..0ede837 --- /dev/null +++ b/services/contextcapture/v1/operations/workspaces-delete/displayName.md @@ -0,0 +1 @@ +Delete a workspace \ No newline at end of file diff --git a/services/contextcapture/v1/operations/workspaces-get/description.md b/services/contextcapture/v1/operations/workspaces-get/description.md new file mode 100644 index 0000000..81e07fe --- /dev/null +++ b/services/contextcapture/v1/operations/workspaces-get/description.md @@ -0,0 +1,11 @@ +--- + +Retrieve workspace information. + +### Parameters + +A workspace id. + +{!Authorization.md!} + +--- diff --git a/services/contextcapture/v1/operations/workspaces-get/displayName.md b/services/contextcapture/v1/operations/workspaces-get/displayName.md new file mode 100644 index 0000000..e60c432 --- /dev/null +++ b/services/contextcapture/v1/operations/workspaces-get/displayName.md @@ -0,0 +1 @@ +Get a workspace \ No newline at end of file diff --git a/services/echo/v2/description.md b/services/echo/v2/description.md new file mode 100644 index 0000000..4619ebb --- /dev/null +++ b/services/echo/v2/description.md @@ -0,0 +1 @@ +Echo API \ No newline at end of file diff --git a/services/echo/v2/operations/context-nested-parameter/description.md b/services/echo/v2/operations/context-nested-parameter/description.md new file mode 100644 index 0000000..4c437b6 --- /dev/null +++ b/services/echo/v2/operations/context-nested-parameter/description.md @@ -0,0 +1 @@ +Context Nested Parameter \ No newline at end of file diff --git a/services/echo/v2/operations/context-nested-parameter/displayName.md b/services/echo/v2/operations/context-nested-parameter/displayName.md new file mode 100644 index 0000000..4c437b6 --- /dev/null +++ b/services/echo/v2/operations/context-nested-parameter/displayName.md @@ -0,0 +1 @@ +Context Nested Parameter \ No newline at end of file diff --git a/services/echo/v2/operations/context-parameter/description.md b/services/echo/v2/operations/context-parameter/description.md new file mode 100644 index 0000000..213c198 --- /dev/null +++ b/services/echo/v2/operations/context-parameter/description.md @@ -0,0 +1 @@ +Context Parameter \ No newline at end of file diff --git a/services/echo/v2/operations/context-parameter/displayName.md b/services/echo/v2/operations/context-parameter/displayName.md new file mode 100644 index 0000000..213c198 --- /dev/null +++ b/services/echo/v2/operations/context-parameter/displayName.md @@ -0,0 +1 @@ +Context Parameter \ No newline at end of file diff --git a/services/echo/v2/operations/context/description.md b/services/echo/v2/operations/context/description.md new file mode 100644 index 0000000..3b18bdc --- /dev/null +++ b/services/echo/v2/operations/context/description.md @@ -0,0 +1 @@ +Context \ No newline at end of file diff --git a/services/echo/v2/operations/context/displayName.md b/services/echo/v2/operations/context/displayName.md new file mode 100644 index 0000000..3b18bdc --- /dev/null +++ b/services/echo/v2/operations/context/displayName.md @@ -0,0 +1 @@ +Context \ No newline at end of file diff --git a/services/export/v1/description.md b/services/export/v1/description.md new file mode 100644 index 0000000..e728f8b --- /dev/null +++ b/services/export/v1/description.md @@ -0,0 +1 @@ +Export API is a cloud-based API meant to export the data from the iModels to other standard formats such as IFC or LandXML. It allows users export data from iModels which are hosted in Bentley's iModelHub to an IFC or LandXML file. \ No newline at end of file diff --git a/services/export/v1/operations/create-export-connection-run/description.md b/services/export/v1/operations/create-export-connection-run/description.md new file mode 100644 index 0000000..7195336 --- /dev/null +++ b/services/export/v1/operations/create-export-connection-run/description.md @@ -0,0 +1,14 @@ +--- + +Runs the specified ExportConnection. + +### Notes + +1. The export process usually takes time and is performed in the background. For that, we need to store the user's refresh token. The refresh token needs to be stored before calling the 'Create ExportConnection Run' end-point. You can get authorization information by using [Get Authorization Information API](https://developer.bentley.com/apis/export/operations/get-authorizationinformation/). This API will return the current status and a redirect URL if the token has to be renewed. + +2. When a run is successfully created, the operation returns HTTP status code 202/accepted - the request is accepted for processing and will execute in background. The response will include a location header pointing to the created run. If an existing active run already exists for the iModel, a new run is not initiated, instead 303/see other is returned along with location header pointing to that existing active run. +In the rare event that multiple create run requests are being made simultaneously, only the first request is processed and 409/conflict is returned for others. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/export/v1/operations/create-export-connection-run/displayName.md b/services/export/v1/operations/create-export-connection-run/displayName.md new file mode 100644 index 0000000..e78aba9 --- /dev/null +++ b/services/export/v1/operations/create-export-connection-run/displayName.md @@ -0,0 +1 @@ +Create ExportConnection Run \ No newline at end of file diff --git a/services/export/v1/operations/create-export-connection/description.md b/services/export/v1/operations/create-export-connection/description.md new file mode 100644 index 0000000..4a0d7cd --- /dev/null +++ b/services/export/v1/operations/create-export-connection/description.md @@ -0,0 +1,11 @@ +--- + +Create a ExportConnection that describes which iModel's data is to be exported. + +{!Authorization.md!} + +### Associated entities + +A connection is linked with an iModel. An iModel ID is required to be set when creating a ExportConnection. + +--- diff --git a/services/export/v1/operations/create-export-connection/displayName.md b/services/export/v1/operations/create-export-connection/displayName.md new file mode 100644 index 0000000..e612198 --- /dev/null +++ b/services/export/v1/operations/create-export-connection/displayName.md @@ -0,0 +1 @@ +Create Export Connection \ No newline at end of file diff --git a/services/export/v1/operations/delete-export-connection/description.md b/services/export/v1/operations/delete-export-connection/description.md new file mode 100644 index 0000000..9b64b09 --- /dev/null +++ b/services/export/v1/operations/delete-export-connection/description.md @@ -0,0 +1,8 @@ +--- + +Delete connection + +{!Authorization.md!} + + +--- diff --git a/services/export/v1/operations/delete-export-connection/displayName.md b/services/export/v1/operations/delete-export-connection/displayName.md new file mode 100644 index 0000000..032642c --- /dev/null +++ b/services/export/v1/operations/delete-export-connection/displayName.md @@ -0,0 +1 @@ +Delete Export Connection \ No newline at end of file diff --git a/services/export/v1/operations/get-authorizationinformation/description.md b/services/export/v1/operations/get-authorizationinformation/description.md new file mode 100644 index 0000000..89776fa --- /dev/null +++ b/services/export/v1/operations/get-authorizationinformation/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves the calling user's Authorization Information. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/export/v1/operations/get-authorizationinformation/displayName.md b/services/export/v1/operations/get-authorizationinformation/displayName.md new file mode 100644 index 0000000..c9918d9 --- /dev/null +++ b/services/export/v1/operations/get-authorizationinformation/displayName.md @@ -0,0 +1 @@ +Get Authorization Information \ No newline at end of file diff --git a/services/export/v1/operations/get-export-connection-run/description.md b/services/export/v1/operations/get-export-connection-run/description.md new file mode 100644 index 0000000..9d8f6a6 --- /dev/null +++ b/services/export/v1/operations/get-export-connection-run/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a ExportConnection Run with the specified ID. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/export/v1/operations/get-export-connection-run/displayName.md b/services/export/v1/operations/get-export-connection-run/displayName.md new file mode 100644 index 0000000..d4395ab --- /dev/null +++ b/services/export/v1/operations/get-export-connection-run/displayName.md @@ -0,0 +1 @@ +Get ExportConnection Run \ No newline at end of file diff --git a/services/export/v1/operations/get-export-connection-runs/description.md b/services/export/v1/operations/get-export-connection-runs/description.md new file mode 100644 index 0000000..ba96478 --- /dev/null +++ b/services/export/v1/operations/get-export-connection-runs/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves all ExportConnection Runs for the specified connection. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/export/v1/operations/get-export-connection-runs/displayName.md b/services/export/v1/operations/get-export-connection-runs/displayName.md new file mode 100644 index 0000000..8f4cdda --- /dev/null +++ b/services/export/v1/operations/get-export-connection-runs/displayName.md @@ -0,0 +1 @@ +Get ExportConnection Runs \ No newline at end of file diff --git a/services/export/v1/operations/get-export-connection/description.md b/services/export/v1/operations/get-export-connection/description.md new file mode 100644 index 0000000..2ae3be3 --- /dev/null +++ b/services/export/v1/operations/get-export-connection/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a ExportConnection with the specified ID. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/export/v1/operations/get-export-connection/displayName.md b/services/export/v1/operations/get-export-connection/displayName.md new file mode 100644 index 0000000..ece0a38 --- /dev/null +++ b/services/export/v1/operations/get-export-connection/displayName.md @@ -0,0 +1 @@ +Get Export Connection \ No newline at end of file diff --git a/services/export/v1/operations/get-export-connections/description.md b/services/export/v1/operations/get-export-connections/description.md new file mode 100644 index 0000000..af92bfa --- /dev/null +++ b/services/export/v1/operations/get-export-connections/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves export connections for the specified iModel. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/export/v1/operations/get-export-connections/displayName.md b/services/export/v1/operations/get-export-connections/displayName.md new file mode 100644 index 0000000..1b7f071 --- /dev/null +++ b/services/export/v1/operations/get-export-connections/displayName.md @@ -0,0 +1 @@ +Get Export Connections \ No newline at end of file diff --git a/services/extensions/v1/description.md b/services/extensions/v1/description.md new file mode 100644 index 0000000..cf4f55a --- /dev/null +++ b/services/extensions/v1/description.md @@ -0,0 +1 @@ +Create, upload and download your iTwin.js Extensions. diff --git a/services/extensions/v1/operations/create-extension-version/description.md b/services/extensions/v1/operations/create-extension-version/description.md new file mode 100644 index 0000000..bb46434 --- /dev/null +++ b/services/extensions/v1/operations/create-extension-version/description.md @@ -0,0 +1,7 @@ +--- + +Creates a new extension version. + +{!Authorization.md!} + +--- diff --git a/services/extensions/v1/operations/create-extension-version/displayName.md b/services/extensions/v1/operations/create-extension-version/displayName.md new file mode 100644 index 0000000..36cc054 --- /dev/null +++ b/services/extensions/v1/operations/create-extension-version/displayName.md @@ -0,0 +1 @@ +Create Extension Version \ No newline at end of file diff --git a/services/extensions/v1/operations/create-private-extension/description.md b/services/extensions/v1/operations/create-private-extension/description.md new file mode 100644 index 0000000..1680956 --- /dev/null +++ b/services/extensions/v1/operations/create-private-extension/description.md @@ -0,0 +1,7 @@ +--- + +Creates a new private extension. + +{!Authorization.md!} + +--- diff --git a/services/extensions/v1/operations/create-private-extension/displayName.md b/services/extensions/v1/operations/create-private-extension/displayName.md new file mode 100644 index 0000000..a039c94 --- /dev/null +++ b/services/extensions/v1/operations/create-private-extension/displayName.md @@ -0,0 +1 @@ +Create Private Extension \ No newline at end of file diff --git a/services/extensions/v1/operations/create-public-itwin-studio-app/description.md b/services/extensions/v1/operations/create-public-itwin-studio-app/description.md new file mode 100644 index 0000000..2b9616d --- /dev/null +++ b/services/extensions/v1/operations/create-public-itwin-studio-app/description.md @@ -0,0 +1,7 @@ +--- + +Creates a new public iTwin Studio App. This endpoint is limited to specific clients. + +{!Authorization.md!} + +--- diff --git a/services/extensions/v1/operations/create-public-itwin-studio-app/displayName.md b/services/extensions/v1/operations/create-public-itwin-studio-app/displayName.md new file mode 100644 index 0000000..8a09b5c --- /dev/null +++ b/services/extensions/v1/operations/create-public-itwin-studio-app/displayName.md @@ -0,0 +1 @@ +Create Public iTwin Studio App \ No newline at end of file diff --git a/services/extensions/v1/operations/delete-extension/description.md b/services/extensions/v1/operations/delete-extension/description.md new file mode 100644 index 0000000..6f35d52 --- /dev/null +++ b/services/extensions/v1/operations/delete-extension/description.md @@ -0,0 +1,10 @@ +--- + +**Used internally for testing purposes only.** + +Deletes an extension, all of its extension versions and the files extracted within each version. + + +{!Authorization.md!} + +--- diff --git a/services/extensions/v1/operations/delete-extension/displayName.md b/services/extensions/v1/operations/delete-extension/displayName.md new file mode 100644 index 0000000..b6142a7 --- /dev/null +++ b/services/extensions/v1/operations/delete-extension/displayName.md @@ -0,0 +1 @@ +Delete Extension \ No newline at end of file diff --git a/services/extensions/v1/operations/get-extension-version/description.md b/services/extensions/v1/operations/get-extension-version/description.md new file mode 100644 index 0000000..a440ee4 --- /dev/null +++ b/services/extensions/v1/operations/get-extension-version/description.md @@ -0,0 +1,7 @@ +--- + +Gets the detailed metadata for a specific version of an extension, including file data. + +{!Authorization.md!} + +--- diff --git a/services/extensions/v1/operations/get-extension-version/displayName.md b/services/extensions/v1/operations/get-extension-version/displayName.md new file mode 100644 index 0000000..1e8b6a4 --- /dev/null +++ b/services/extensions/v1/operations/get-extension-version/displayName.md @@ -0,0 +1 @@ +Get Extension Version \ No newline at end of file diff --git a/services/extensions/v1/operations/get-extension-versions/description.md b/services/extensions/v1/operations/get-extension-versions/description.md new file mode 100644 index 0000000..1d55d2a --- /dev/null +++ b/services/extensions/v1/operations/get-extension-versions/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a list of extension versions that are associated with the extension provided through the extension ID. + +{!Authorization.md!} + +--- diff --git a/services/extensions/v1/operations/get-extension-versions/displayName.md b/services/extensions/v1/operations/get-extension-versions/displayName.md new file mode 100644 index 0000000..45b7865 --- /dev/null +++ b/services/extensions/v1/operations/get-extension-versions/displayName.md @@ -0,0 +1 @@ +Get Extension's Versions \ No newline at end of file diff --git a/services/extensions/v1/operations/get-extensions/description.md b/services/extensions/v1/operations/get-extensions/description.md new file mode 100644 index 0000000..eaa459e --- /dev/null +++ b/services/extensions/v1/operations/get-extensions/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a list of Extensions. If an iTwinId was passed into the request, it will retrieve a list of extensions associated with that iTwin account. Else, it returns all public extensions. + +{!Authorization.md!} + +--- diff --git a/services/extensions/v1/operations/get-extensions/displayName.md b/services/extensions/v1/operations/get-extensions/displayName.md new file mode 100644 index 0000000..0f863d6 --- /dev/null +++ b/services/extensions/v1/operations/get-extensions/displayName.md @@ -0,0 +1 @@ +Get Extensions \ No newline at end of file diff --git a/services/extensions/v1/operations/get-latest-extension-version/description.md b/services/extensions/v1/operations/get-latest-extension-version/description.md new file mode 100644 index 0000000..e15bddb --- /dev/null +++ b/services/extensions/v1/operations/get-latest-extension-version/description.md @@ -0,0 +1,7 @@ +--- + +Gets the latest version of an extension available for download, compatible with an optionally provided iTwin.js version. + +{!Authorization.md!} + +--- diff --git a/services/extensions/v1/operations/get-latest-extension-version/displayName.md b/services/extensions/v1/operations/get-latest-extension-version/displayName.md new file mode 100644 index 0000000..b73ae6d --- /dev/null +++ b/services/extensions/v1/operations/get-latest-extension-version/displayName.md @@ -0,0 +1 @@ +Get Latest Extension Version \ No newline at end of file diff --git a/services/extensions/v1/operations/update-extension/description.md b/services/extensions/v1/operations/update-extension/description.md new file mode 100644 index 0000000..f0b63e7 --- /dev/null +++ b/services/extensions/v1/operations/update-extension/description.md @@ -0,0 +1,7 @@ +--- + +Update an extension. Only description field can be modified on the extension. The update extension is currently only available for private extensions. + +{!Authorization.md!} + +--- diff --git a/services/extensions/v1/operations/update-extension/displayName.md b/services/extensions/v1/operations/update-extension/displayName.md new file mode 100644 index 0000000..a1e808f --- /dev/null +++ b/services/extensions/v1/operations/update-extension/displayName.md @@ -0,0 +1 @@ +Update Extension \ No newline at end of file diff --git a/services/forms/v1/description.md b/services/forms/v1/description.md new file mode 100644 index 0000000..06dbee1 --- /dev/null +++ b/services/forms/v1/description.md @@ -0,0 +1,13 @@ +Forms Service + +View, create, and edit details of forms that have been filled out for an iTwin/project, as well as their comments, attached files, and change history. Full CRUD functionality is available for form data, with form definitions being available in a read-only context. + +Note that throughout this API the terms "form" (by itself) and "form data" both refer to the same thing: data collected from users (generally entered into controls of a UI, or programmatically generated). By contrast, a "form definition" is a piece of metadata connected to form data instances. It determines the "type" of form that is filled out, and in applications that support custom form layouts, it determines how the controls are placed in the user interface. + +Form definitions should be added, imported, and customized by project administrators through the Bentley Form Manager web application; they cannot be modified using this API. The app can be found at https://connect-formmanager.bentley.com/designer/#/your-itwin-id (replace `your-itwin-id` with the ID of the actual iTwin or project whose form definitions you want to customize). + +## Limits + +All API calls that return a list of results will return a maximum of 50 results. Some endpoints support a `$top` parameter to specify a number of results to retrieve (up to the maximum) and a `continuationToken` parameter to continue paging through results, allowing access to results beyond the first 50. These parameters will be included in the documentation for those endpoints. + +Clients with a Developer, Partner, or Integrator subscription will be limited to 5000 requests per minute. Clients with a Trial subscription will be limited to 500 requests per minute. \ No newline at end of file diff --git a/services/forms/v1/operations/add-attachment-to-form/description.md b/services/forms/v1/operations/add-attachment-to-form/description.md new file mode 100644 index 0000000..44e6f36 --- /dev/null +++ b/services/forms/v1/operations/add-attachment-to-form/description.md @@ -0,0 +1,11 @@ +--- + +Adds a new attachment to the specified form data instance. This only creates the attachment metadata; the file will need to be uploaded through a subsequent PUT call to the URL returned in the Location header of this endpoint's response. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the form's definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/add-attachment-to-form/displayName.md b/services/forms/v1/operations/add-attachment-to-form/displayName.md new file mode 100644 index 0000000..7868550 --- /dev/null +++ b/services/forms/v1/operations/add-attachment-to-form/displayName.md @@ -0,0 +1 @@ +Add attachment to form \ No newline at end of file diff --git a/services/forms/v1/operations/add-comment-to-form/description.md b/services/forms/v1/operations/add-comment-to-form/description.md new file mode 100644 index 0000000..22b52b5 --- /dev/null +++ b/services/forms/v1/operations/add-comment-to-form/description.md @@ -0,0 +1,11 @@ +--- + +Adds a new comment to the specified form data instance. Only the comment text is needed; the author and creation time will be automatically set by the server. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the form's definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/add-comment-to-form/displayName.md b/services/forms/v1/operations/add-comment-to-form/displayName.md new file mode 100644 index 0000000..7aa74b0 --- /dev/null +++ b/services/forms/v1/operations/add-comment-to-form/displayName.md @@ -0,0 +1 @@ +Add comment to form \ No newline at end of file diff --git a/services/forms/v1/operations/create-form-data/description.md b/services/forms/v1/operations/create-form-data/description.md new file mode 100644 index 0000000..7586493 --- /dev/null +++ b/services/forms/v1/operations/create-form-data/description.md @@ -0,0 +1,11 @@ +--- + +Creates a new form data instance. The user must specify the ID of a form definition to associate the instance with; that will set the instance's form type as well as determine how clients such as the CONNECT Forms web app will display it. The form definition ID should be obtained by calling the 'Get iTwin form definitions' endpoint. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Create** (`Forms_CreateAccess`) permission for the project, or for the form's definition if form definition security is specified. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/create-form-data/displayName.md b/services/forms/v1/operations/create-form-data/displayName.md new file mode 100644 index 0000000..c7a20e2 --- /dev/null +++ b/services/forms/v1/operations/create-form-data/displayName.md @@ -0,0 +1 @@ +Create form data \ No newline at end of file diff --git a/services/forms/v1/operations/delete-attachment/description.md b/services/forms/v1/operations/delete-attachment/description.md new file mode 100644 index 0000000..6c33484 --- /dev/null +++ b/services/forms/v1/operations/delete-attachment/description.md @@ -0,0 +1,11 @@ +--- + +Deletes the specified attachment (including both its metadata and file) from the specified form. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the form's definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/delete-attachment/displayName.md b/services/forms/v1/operations/delete-attachment/displayName.md new file mode 100644 index 0000000..b879ec7 --- /dev/null +++ b/services/forms/v1/operations/delete-attachment/displayName.md @@ -0,0 +1 @@ +Delete attachment \ No newline at end of file diff --git a/services/forms/v1/operations/delete-comment/description.md b/services/forms/v1/operations/delete-comment/description.md new file mode 100644 index 0000000..9e8d30d --- /dev/null +++ b/services/forms/v1/operations/delete-comment/description.md @@ -0,0 +1,11 @@ +--- + +Deletes the specified comment from the specified form. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the form's definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/delete-comment/displayName.md b/services/forms/v1/operations/delete-comment/displayName.md new file mode 100644 index 0000000..f8af28e --- /dev/null +++ b/services/forms/v1/operations/delete-comment/displayName.md @@ -0,0 +1 @@ +Delete comment \ No newline at end of file diff --git a/services/forms/v1/operations/delete-form-data/description.md b/services/forms/v1/operations/delete-form-data/description.md new file mode 100644 index 0000000..c8949b5 --- /dev/null +++ b/services/forms/v1/operations/delete-form-data/description.md @@ -0,0 +1,11 @@ +--- + +Deletes the form data instance with the specified ID. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Delete** (`Forms_DeleteForms`) permission for the iTwin. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/delete-form-data/displayName.md b/services/forms/v1/operations/delete-form-data/displayName.md new file mode 100644 index 0000000..8fe8ff6 --- /dev/null +++ b/services/forms/v1/operations/delete-form-data/displayName.md @@ -0,0 +1 @@ +Delete form data \ No newline at end of file diff --git a/services/forms/v1/operations/download-form-as-file/description.md b/services/forms/v1/operations/download-form-as-file/description.md new file mode 100644 index 0000000..e25bacc --- /dev/null +++ b/services/forms/v1/operations/download-form-as-file/description.md @@ -0,0 +1,9 @@ +--- + +Gets the specified form exported to the specified file format. Currently, the default--and only supported format--is PDF. The form with the specified ID will be laid out in the PDF according to its associated form definition. + +The generated PDF will have a header at the top of each page with metadata about the form (such as its name and creation date) unless the 'includeHeader' query parameter is set to false. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/download-form-as-file/displayName.md b/services/forms/v1/operations/download-form-as-file/displayName.md new file mode 100644 index 0000000..46094c5 --- /dev/null +++ b/services/forms/v1/operations/download-form-as-file/displayName.md @@ -0,0 +1 @@ +Download form as file \ No newline at end of file diff --git a/services/forms/v1/operations/export-form-to-storage/description.md b/services/forms/v1/operations/export-form-to-storage/description.md new file mode 100644 index 0000000..fb0c842 --- /dev/null +++ b/services/forms/v1/operations/export-form-to-storage/description.md @@ -0,0 +1,13 @@ +--- + +Requests that anywhere from 1 to 5 forms be exported to a file and saved in cloud-based storage for this iTwin (accessible through the Storage API). Currently 'pdf' is the only supported file type. The IDs of the forms must be specified in a query string parameter named "ids", separated by commas if there is more than one. A sample request URL that exports 3 forms to a PDF is as follows-- + +https://api.bentley.com/forms/exportPdfToStorage?fileType=pdf&ids=abab23524535,89458jjlij,32636wtewtwt&folderId=090909877987&includeHeader=true + +Note that unlike most GET requests, this is not an idempotent operation; each time it is called, a new file will be generated. The response will not contain the file itself, but links to download it from Storage. + +All forms specified in the request must come from the same iTwin, or the request will fail. The client may also specify the ID of a destination folder where the file should be saved; otherwise, it will be saved in the iTwin's root folder. They can also specify whether to include a textual header with form metadata at the top of each page (default) or exclude it. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/export-form-to-storage/displayName.md b/services/forms/v1/operations/export-form-to-storage/displayName.md new file mode 100644 index 0000000..2809e73 --- /dev/null +++ b/services/forms/v1/operations/export-form-to-storage/displayName.md @@ -0,0 +1 @@ +Export forms to Storage \ No newline at end of file diff --git a/services/forms/v1/operations/get-attachment-file-by-id/description.md b/services/forms/v1/operations/get-attachment-file-by-id/description.md new file mode 100644 index 0000000..40055d4 --- /dev/null +++ b/services/forms/v1/operations/get-attachment-file-by-id/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves the actual file contents for the attachment with the given ID. This API will attempt to infer the MIME type to return from the file's extension, but will return the default value of `application/octet-stream` if it does not recognize the extension. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the form's definition if form definition security is specified. (Having any other Forms permission automatically grants the **View** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/get-attachment-file-by-id/displayName.md b/services/forms/v1/operations/get-attachment-file-by-id/displayName.md new file mode 100644 index 0000000..f7ec252 --- /dev/null +++ b/services/forms/v1/operations/get-attachment-file-by-id/displayName.md @@ -0,0 +1 @@ +Get attachment file by ID \ No newline at end of file diff --git a/services/forms/v1/operations/get-audit-trail-for-form-data/description.md b/services/forms/v1/operations/get-audit-trail-for-form-data/description.md new file mode 100644 index 0000000..1547b2c --- /dev/null +++ b/services/forms/v1/operations/get-audit-trail-for-form-data/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves a reverse-chronologically-ordered list of all changes that have been made to this form data instance, including authors, dates, and old vs. new property values. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the form's definition if form definition security is specified. (Having any other Forms permission automatically grants the **View** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/get-audit-trail-for-form-data/displayName.md b/services/forms/v1/operations/get-audit-trail-for-form-data/displayName.md new file mode 100644 index 0000000..5f7702f --- /dev/null +++ b/services/forms/v1/operations/get-audit-trail-for-form-data/displayName.md @@ -0,0 +1 @@ +Get audit trail for form data \ No newline at end of file diff --git a/services/forms/v1/operations/get-form-data-attachments/description.md b/services/forms/v1/operations/get-form-data-attachments/description.md new file mode 100644 index 0000000..6831165 --- /dev/null +++ b/services/forms/v1/operations/get-form-data-attachments/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves the metadata for all files attached to the given form data. In order to get the contents of a file itself, use the `Get attachment file by ID` endpoint, passing the `id` from the metadata object returned by this request as the `attachmentId` parameter of that request. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the form's definition if form definition security is specified. (Having any other Forms permission automatically grants the **View** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/get-form-data-attachments/displayName.md b/services/forms/v1/operations/get-form-data-attachments/displayName.md new file mode 100644 index 0000000..521bea1 --- /dev/null +++ b/services/forms/v1/operations/get-form-data-attachments/displayName.md @@ -0,0 +1 @@ +Get form data attachments \ No newline at end of file diff --git a/services/forms/v1/operations/get-form-data-comments/description.md b/services/forms/v1/operations/get-form-data-comments/description.md new file mode 100644 index 0000000..0667c41 --- /dev/null +++ b/services/forms/v1/operations/get-form-data-comments/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves the text and metadata for all comments that have been posted to the given form data instance. If the Prefer header was specified with the value "return=representation", the response will include the email address of each comment author, though this may incur additional processing time. If there is an extraordinarily large number of comments, only 50 distinct user email addresses will be retrieved and shown. Regardless of the Prefer header value, the "_links" object associated with each comment will provide a link to additional information about the comment author. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the form's definition if form definition security is specified. (Having any other Forms permission automatically grants the **View** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/get-form-data-comments/displayName.md b/services/forms/v1/operations/get-form-data-comments/displayName.md new file mode 100644 index 0000000..7e4d481 --- /dev/null +++ b/services/forms/v1/operations/get-form-data-comments/displayName.md @@ -0,0 +1 @@ +Get form data comments \ No newline at end of file diff --git a/services/forms/v1/operations/get-form-data-details/description.md b/services/forms/v1/operations/get-form-data-details/description.md new file mode 100644 index 0000000..83bd2b3 --- /dev/null +++ b/services/forms/v1/operations/get-form-data-details/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves all properties of the specified form data instance. + +Known, common properties will be returned directly on the 'formData' object, whereas custom properties unique to the form's type will be returned on the 'properties' sub-object. + +Note that many properties in the schema are described as 'Origin info.' This means that they are metadata about where the form data came from and what business domain object(s) it is related to, such as a PDF file or a 3D model. Their meanings can differ from application to application. Many applications will use only a subset of these properties, and in general applications SHOULD NOT use or set these values unless they have a good reason to do so. Other properties, not marked 'Origin info', are defined for all form types, but clients SHOULD NOT assume that all of them are set. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the form's definition if form definition security is specified. (Having any other Forms permission automatically grants the **View** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/get-form-data-details/displayName.md b/services/forms/v1/operations/get-form-data-details/displayName.md new file mode 100644 index 0000000..800ecf7 --- /dev/null +++ b/services/forms/v1/operations/get-form-data-details/displayName.md @@ -0,0 +1 @@ +Get form data details \ No newline at end of file diff --git a/services/forms/v1/operations/get-form-definition-by-id/description.md b/services/forms/v1/operations/get-form-definition-by-id/description.md new file mode 100644 index 0000000..5f5ca5d --- /dev/null +++ b/services/forms/v1/operations/get-form-definition-by-id/description.md @@ -0,0 +1,7 @@ +--- + +Gets the full form definition with the specified ID. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/get-form-definition-by-id/displayName.md b/services/forms/v1/operations/get-form-definition-by-id/displayName.md new file mode 100644 index 0000000..da62ef6 --- /dev/null +++ b/services/forms/v1/operations/get-form-definition-by-id/displayName.md @@ -0,0 +1 @@ +Get form definition by ID \ No newline at end of file diff --git a/services/forms/v1/operations/get-list-group/description.md b/services/forms/v1/operations/get-list-group/description.md new file mode 100644 index 0000000..121f740 --- /dev/null +++ b/services/forms/v1/operations/get-list-group/description.md @@ -0,0 +1,11 @@ +--- + +Use this request to look up a list group, which is a nested object structure that defines the options available in a chain of cascading list form controls. (Cascading lists are a set of <select> elements where only the first one is initially enabled until an option in it is selected, and then, depending on which option was selected, the available options in the next list can vary.) Each property in the structure represents an option in a select list, and its children represent options that become available in the next list in the chain if that option is selected. + +### Sample Explanation + +The sample for the 200 response shows an example of a list group that could be assigned to 3 controls in a form to let the user pick an American football team by conference, division, and name. Since the result has two properties ("AFC" and "NFC") as direct children of the "optionsTree" property, the first list in the cascading list chain would have two options--"AFC" and "NFC". Whichever option is chosen, its child properties become available for selection in the second list, and so forth. For example, if "AFC" and "North" were chosen for the first two lists respectively, the third list would show the available options "Bengals", "Browns", "Ravens", and "Steelers". These four properties just have empty objects as their values because this particular list group only has three layers; these options are the final options in the chain and have no descendants. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/get-list-group/displayName.md b/services/forms/v1/operations/get-list-group/displayName.md new file mode 100644 index 0000000..1021dc9 --- /dev/null +++ b/services/forms/v1/operations/get-list-group/displayName.md @@ -0,0 +1 @@ +Get list group \ No newline at end of file diff --git a/services/forms/v1/operations/get-project-form-data/description.md b/services/forms/v1/operations/get-project-form-data/description.md new file mode 100644 index 0000000..2993a42 --- /dev/null +++ b/services/forms/v1/operations/get-project-form-data/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves a list of form data instances for the iTwin with the given ID. If the Prefer header is omitted, or set to "return=minimal", this only returns basic info about each form--its ID, display name, type, and whether it is in an Open, Closed, or Draft state. Setting the Prefer header to "return=representation" will return more data. Use the "Get Form Data Details" endpoint to see full information about a particular form. + +Note that the 'iTwinId' query string parameter is required. It must be a valid iTwin or project GUID to get forms from. Old clients can continue to use the 'projectId' parameter as an alias for 'iTwinId'. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** permission (`Forms_ViewAccess`) for the iTwin, or for some forms' definitions if form definition security is specified. (Having any other ProjectWise Forms permission automatically grants the **View** permission as well. If a user does not have permission to view a particular form, it will be silently excluded from the list.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/get-project-form-data/displayName.md b/services/forms/v1/operations/get-project-form-data/displayName.md new file mode 100644 index 0000000..e55b319 --- /dev/null +++ b/services/forms/v1/operations/get-project-form-data/displayName.md @@ -0,0 +1 @@ +Get iTwin form data \ No newline at end of file diff --git a/services/forms/v1/operations/get-project-form-definitions/description.md b/services/forms/v1/operations/get-project-form-definitions/description.md new file mode 100644 index 0000000..481c2f6 --- /dev/null +++ b/services/forms/v1/operations/get-project-form-definitions/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves a list of Approved form definitions for the iTwin with the given ID. This only returns the definition's name, type, and ID. The full definitions will be returned in the 'Get form definition by ID' endpoint. + +Note that in order to create a form data instance, it must be associated with the ID of one of these form definitions (through the 'formId' property in the 'Create form data' request body). This API cannot be used to create or edit form definitions. They can only be created/edited/imported by iTwin administrators through the Bentley Form Manager webapp, which is accessible at https://connect-formmanager.bentley.com/designer/#/your-itwin-id (replace `your-itwin-id` with your actual project or iTwin ID). + +Note that the 'iTwinId' query string parameter is required. It must be a valid iTwin or project GUID to get form definitions from. Existing clients can continue to use the 'projectId' parameter as an alias for 'iTwinId'. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/get-project-form-definitions/displayName.md b/services/forms/v1/operations/get-project-form-definitions/displayName.md new file mode 100644 index 0000000..f8f3335 --- /dev/null +++ b/services/forms/v1/operations/get-project-form-definitions/displayName.md @@ -0,0 +1 @@ +Get iTwin form definitions \ No newline at end of file diff --git a/services/forms/v1/operations/get-static-image/description.md b/services/forms/v1/operations/get-static-image/description.md new file mode 100644 index 0000000..71435dd --- /dev/null +++ b/services/forms/v1/operations/get-static-image/description.md @@ -0,0 +1,7 @@ +--- + +Gets a link to a static image to be displayed in a form. The 'fileId' parameter should match the 'fileId' property of a static image control in the form's definition. It will be a positive integer. This endpoint returns only a _links object containing the URL of the actual file, which is publicly, though temporarily, available at that address and can be set as the 'src' attribute of an HTML tag to display the image. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/get-static-image/displayName.md b/services/forms/v1/operations/get-static-image/displayName.md new file mode 100644 index 0000000..cc47498 --- /dev/null +++ b/services/forms/v1/operations/get-static-image/displayName.md @@ -0,0 +1 @@ +Get static image \ No newline at end of file diff --git a/services/forms/v1/operations/get-workflow/description.md b/services/forms/v1/operations/get-workflow/description.md new file mode 100644 index 0000000..17635b1 --- /dev/null +++ b/services/forms/v1/operations/get-workflow/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves the workflow for the given form type in the given iTwin or project. The iTwin or project ID must be specified using the 'iTwinId' query string parameter. Existing clients can continue to use the 'projectId' parameter as an alias for 'iTwinId'. + +It is possible for users of a project to choose not to set a workflow for a given type. In that case, requests to get the workflow of that type will return a 404 Not Found response where the 'code' property of the body's 'error' object is set to "WorkflowNotFound". This does not indicate client or server error. Other HTTP status codes, or other values of the 'code' property, do indicate an unexpected error of some sort. + +Note that workflows cannot be customized through this API; they can only be added, deleted, or changed manually by iTwin administrators through the Bentley Form Manager webapp, found at https://connect-formmanager.bentley.com/designer/#/your-itwin-id (replace `your-itwin-id` with your actual project or iTwin ID). + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/get-workflow/displayName.md b/services/forms/v1/operations/get-workflow/displayName.md new file mode 100644 index 0000000..2ac3eaf --- /dev/null +++ b/services/forms/v1/operations/get-workflow/displayName.md @@ -0,0 +1 @@ +Get workflow \ No newline at end of file diff --git a/services/forms/v1/operations/update-form-data/description.md b/services/forms/v1/operations/update-form-data/description.md new file mode 100644 index 0000000..cfe4ab4 --- /dev/null +++ b/services/forms/v1/operations/update-form-data/description.md @@ -0,0 +1,19 @@ +--- + +Modifies the provided properties of the specified form to match the values provided in the request. + +Setting a property value to null in the request will set the corresponding property value to null on the form. However, omitting a property from the request body entirely will leave that property's current value on the form unchanged. Also, setting an object (other than "properties") to null will have the same effect as setting each individual property in that object to null. + +### Permissions + +To use this endpoint, the user is required to have different Forms permission levels (for the iTwin, or for the form's definition if form definition security is specified) based on the changes being made: + +- Change to the `status` property: **Approve** (`Forms_ApproveAccess`) permission +- Change to the `assignee` or `assignees` property: **Assign** (`Forms_AssignAccess`) or **Approve** permission +- Changes to other properties: **Create/Modify** (`Forms_CreateAccess`) permission + +**Full Access** (`Forms_FullAccess`) will satisfy all of these requirements. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/update-form-data/displayName.md b/services/forms/v1/operations/update-form-data/displayName.md new file mode 100644 index 0000000..ecc4b2d --- /dev/null +++ b/services/forms/v1/operations/update-form-data/displayName.md @@ -0,0 +1 @@ +Update form data \ No newline at end of file diff --git a/services/forms/v1/operations/upload-attachment-file/description.md b/services/forms/v1/operations/upload-attachment-file/description.md new file mode 100644 index 0000000..86f3f82 --- /dev/null +++ b/services/forms/v1/operations/upload-attachment-file/description.md @@ -0,0 +1,11 @@ +--- + +Uploads a file's contents, associating it with the attachment metadata instance with the given ID. The request body is simply the file's bytes. If a file was already uploaded for the attachment with the given ID, that file will be overwritten. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Comment** permission (`Forms_CommentAccess`) for the iTwin, or for the form's definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/forms/v1/operations/upload-attachment-file/displayName.md b/services/forms/v1/operations/upload-attachment-file/displayName.md new file mode 100644 index 0000000..aefe0db --- /dev/null +++ b/services/forms/v1/operations/upload-attachment-file/displayName.md @@ -0,0 +1 @@ +Upload attachment file \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/description.md b/services/grouping-and-mapping/v1/description.md new file mode 100644 index 0000000..d92e468 --- /dev/null +++ b/services/grouping-and-mapping/v1/description.md @@ -0,0 +1 @@ +Reduce, categorize, and augment iModel data into optimized representations for consumption by downstream apps. \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/create-group/description.md b/services/grouping-and-mapping/v1/operations/create-group/description.md new file mode 100644 index 0000000..5c76f5a --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/create-group/description.md @@ -0,0 +1,29 @@ +--- + +Creates a group. A group is a collection of design elements from an iModel represented by an [ECSQL](https://www.itwinjs.org/learning/ecsql/) query. When used for reporting a group represents a single output data table in a report. There are two ways to create a group. + +### Create a group without properties + +To create a group without properties do not provide the `source` property. + +### Create a group from an existing group + +To create a group from another group provide the `source` property. The server will create a new group and copy over all properties from the group referenced by the `source` property. User must have `imodels_read` permissions to the iModel containing the source group. Changing source group or its properties will not change the copies of them. + +Provided `groupName`, `description`, `query`, `metadata` request body properties will overwrite the properties on the copied group. + +### Note + +The `query` request body property must be provided even when copying a group. Provide the source group query in the request when copying a group if you want to keep the same query. + +{!GroupQuery.md!} + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +{!ExtractionRowLimiting.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/create-group/displayName.md b/services/grouping-and-mapping/v1/operations/create-group/displayName.md new file mode 100644 index 0000000..69cd6d6 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/create-group/displayName.md @@ -0,0 +1 @@ +Create Group \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/create-mapping/description.md b/services/grouping-and-mapping/v1/operations/create-mapping/description.md new file mode 100644 index 0000000..874cdb4 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/create-mapping/description.md @@ -0,0 +1,25 @@ +--- + +Creates a mapping for an iModel. There are two ways to create a mapping. + +### Create an empty mapping + +To create an empty mapping do not provide the `sourceMappingId` property. This will create a new mapping that does not have any groups. + +### Create a mapping from an existing mapping + +To create a mapping from another mapping provide the `sourceMappingId` property. The server will create a new mapping and copy over all of the groups with their properties from the mapping referenced by the `sourceMappingId` property. User must have `imodels_read` permissions to the iModel containing the source mapping. Changing source mapping, groups, or their properties will not change the copies of them. + +Provided `mappingName`, `description`, `extractionEnabled` request body properties will overwrite the properties on the copied mapping. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!ExtractionTriggersAndConfiguration.md!} + +{!RateLimits.md!} + +{!ExtractionRowLimiting.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/create-mapping/displayName.md b/services/grouping-and-mapping/v1/operations/create-mapping/displayName.md new file mode 100644 index 0000000..6bc40b0 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/create-mapping/displayName.md @@ -0,0 +1 @@ +Create Mapping \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/create-property/description.md b/services/grouping-and-mapping/v1/operations/create-property/description.md new file mode 100644 index 0000000..654be12 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/create-property/description.md @@ -0,0 +1,27 @@ +--- + +Creates a property. If group is a table, then property of that group is a column. Properties can be mapped from existing iModel ECProperties, calculated using a predefined list of calculations, or calculated using your own mathematical formula. + +Source of the property value in the output is defined by the `ecProperties`, `calculatedPropertyType`, and `formula` values on a property. You can provide any combination of these properties. If you do not provided any of them, the output value will always be null. Such properties can be used as placeholders or to define an output schema before any property mapping is done. However, when you provide 2 or more of these properties they are evaluated in this order until a valid value (not null or undefined) is found: + +1. `ecProperties` +2. `calculatedPropertyType` +3. `formula` + +Property values are assigned during data extraction. To start the data extraction use [Run Extraction](/apis/insights/operations/run-extraction) operation. + +{!MappingECProperties.md!} + +{!CalculationTypes.md!} + +{!CustomCalculations.md!} + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +{!ExtractionRowLimiting.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/create-property/displayName.md b/services/grouping-and-mapping/v1/operations/create-property/displayName.md new file mode 100644 index 0000000..c0d3041 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/create-property/displayName.md @@ -0,0 +1 @@ +Create Property \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/delete-group/description.md b/services/grouping-and-mapping/v1/operations/delete-group/description.md new file mode 100644 index 0000000..33206e1 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/delete-group/description.md @@ -0,0 +1,13 @@ +--- + +Deletes a group. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +{!ExtractionRowLimiting.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/delete-group/displayName.md b/services/grouping-and-mapping/v1/operations/delete-group/displayName.md new file mode 100644 index 0000000..054678e --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/delete-group/displayName.md @@ -0,0 +1 @@ +Delete Group \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/delete-mapping/description.md b/services/grouping-and-mapping/v1/operations/delete-mapping/description.md new file mode 100644 index 0000000..d6c8332 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/delete-mapping/description.md @@ -0,0 +1,13 @@ +--- + +Deletes a mapping. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +{!ExtractionRowLimiting.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/delete-mapping/displayName.md b/services/grouping-and-mapping/v1/operations/delete-mapping/displayName.md new file mode 100644 index 0000000..f9d5c74 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/delete-mapping/displayName.md @@ -0,0 +1 @@ +Delete Mapping \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/delete-property/description.md b/services/grouping-and-mapping/v1/operations/delete-property/description.md new file mode 100644 index 0000000..03af22d --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/delete-property/description.md @@ -0,0 +1,13 @@ +--- + +Deletes a property. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +{!ExtractionRowLimiting.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/delete-property/displayName.md b/services/grouping-and-mapping/v1/operations/delete-property/displayName.md new file mode 100644 index 0000000..645cc94 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/delete-property/displayName.md @@ -0,0 +1 @@ +Delete Property \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-audittrail-imodel/description.md b/services/grouping-and-mapping/v1/operations/get-audittrail-imodel/description.md new file mode 100644 index 0000000..11e3280 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-audittrail-imodel/description.md @@ -0,0 +1,13 @@ +--- + +Gets Audit Trail Entries. + +{!AuditQuery.md!} + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-audittrail-imodel/displayName.md b/services/grouping-and-mapping/v1/operations/get-audittrail-imodel/displayName.md new file mode 100644 index 0000000..97a10dc --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-audittrail-imodel/displayName.md @@ -0,0 +1 @@ +Get AuditTrail \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-cdm-partition/description.md b/services/grouping-and-mapping/v1/operations/get-cdm-partition/description.md new file mode 100644 index 0000000..9e8e9ad --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-cdm-partition/description.md @@ -0,0 +1,13 @@ +--- + +Gets the extracted data in CSV format. + +CSV column order matches the entity attribute order returned by the [Get CDM](/apis/grouping-and-mapping/operations/get-cdm) operation. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-cdm-partition/displayName.md b/services/grouping-and-mapping/v1/operations/get-cdm-partition/displayName.md new file mode 100644 index 0000000..6974c2c --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-cdm-partition/displayName.md @@ -0,0 +1 @@ +Get CDM Partition \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-cdm/description.md b/services/grouping-and-mapping/v1/operations/get-cdm/description.md new file mode 100644 index 0000000..ab60393 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-cdm/description.md @@ -0,0 +1,11 @@ +--- + +Gets the data model of extracted data in Common Data Model (CDM) format. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-cdm/displayName.md b/services/grouping-and-mapping/v1/operations/get-cdm/displayName.md new file mode 100644 index 0000000..74d9b53 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-cdm/displayName.md @@ -0,0 +1 @@ +Get CDM \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-extraction-logs/description.md b/services/grouping-and-mapping/v1/operations/get-extraction-logs/description.md new file mode 100644 index 0000000..653ff41 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-extraction-logs/description.md @@ -0,0 +1,11 @@ +--- + +Gets the logs of an extraction. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-extraction-logs/displayName.md b/services/grouping-and-mapping/v1/operations/get-extraction-logs/displayName.md new file mode 100644 index 0000000..4e3c7ae --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-extraction-logs/displayName.md @@ -0,0 +1 @@ +Get Extraction Logs \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-extraction-status/description.md b/services/grouping-and-mapping/v1/operations/get-extraction-status/description.md new file mode 100644 index 0000000..f8c2f08 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-extraction-status/description.md @@ -0,0 +1,11 @@ +--- + +Gets the status of an extraction. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-extraction-status/displayName.md b/services/grouping-and-mapping/v1/operations/get-extraction-status/displayName.md new file mode 100644 index 0000000..1fa46f9 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-extraction-status/displayName.md @@ -0,0 +1 @@ +Get Extraction Status \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-group/description.md b/services/grouping-and-mapping/v1/operations/get-group/description.md new file mode 100644 index 0000000..94ca251 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-group/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves a group. + +{!GroupQuery.md!} + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-group/displayName.md b/services/grouping-and-mapping/v1/operations/get-group/displayName.md new file mode 100644 index 0000000..b718712 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-group/displayName.md @@ -0,0 +1 @@ +Get Group \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-groups/description.md b/services/grouping-and-mapping/v1/operations/get-groups/description.md new file mode 100644 index 0000000..7e74757 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-groups/description.md @@ -0,0 +1,22 @@ +--- + +Gets all groups of a mapping. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!GroupQuery.md!} + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-groups/displayName.md b/services/grouping-and-mapping/v1/operations/get-groups/displayName.md new file mode 100644 index 0000000..0d281b2 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-groups/displayName.md @@ -0,0 +1 @@ +Get Groups \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-imodel-extractions/description.md b/services/grouping-and-mapping/v1/operations/get-imodel-extractions/description.md new file mode 100644 index 0000000..b5cf9c6 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-imodel-extractions/description.md @@ -0,0 +1,11 @@ +--- + +Gets all of the extractions that were run on a given iModel. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-imodel-extractions/displayName.md b/services/grouping-and-mapping/v1/operations/get-imodel-extractions/displayName.md new file mode 100644 index 0000000..0ec211c --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-imodel-extractions/displayName.md @@ -0,0 +1 @@ +Get iModel Extractions \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-mapping-extractions/description.md b/services/grouping-and-mapping/v1/operations/get-mapping-extractions/description.md new file mode 100644 index 0000000..2568489 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-mapping-extractions/description.md @@ -0,0 +1,11 @@ +--- + +Gets a list of extractions executed on a mapping. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-mapping-extractions/displayName.md b/services/grouping-and-mapping/v1/operations/get-mapping-extractions/displayName.md new file mode 100644 index 0000000..11f77ef --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-mapping-extractions/displayName.md @@ -0,0 +1 @@ +Get Mapping Extractions \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-mapping/description.md b/services/grouping-and-mapping/v1/operations/get-mapping/description.md new file mode 100644 index 0000000..69d1274 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-mapping/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves a mapping. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-mapping/displayName.md b/services/grouping-and-mapping/v1/operations/get-mapping/displayName.md new file mode 100644 index 0000000..ea96b0b --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-mapping/displayName.md @@ -0,0 +1 @@ +Get Mapping \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-mappings/description.md b/services/grouping-and-mapping/v1/operations/get-mappings/description.md new file mode 100644 index 0000000..76d9825 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-mappings/description.md @@ -0,0 +1,11 @@ +--- + +Gets all mappings of an iModel. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-mappings/displayName.md b/services/grouping-and-mapping/v1/operations/get-mappings/displayName.md new file mode 100644 index 0000000..fc3962f --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-mappings/displayName.md @@ -0,0 +1 @@ +Get Mappings \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-properties/description.md b/services/grouping-and-mapping/v1/operations/get-properties/description.md new file mode 100644 index 0000000..fd20755 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-properties/description.md @@ -0,0 +1,19 @@ +--- + +Gets all group properties. If group is a table, then property of that group is a column. + +Property values are assigned during data extraction. To start the data extraction use [Run Extraction](/apis/insights/operations/run-extraction) operation. + +{!MappingECProperties.md!} + +{!CalculationTypes.md!} + +{!CustomCalculations.md!} + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-properties/displayName.md b/services/grouping-and-mapping/v1/operations/get-properties/displayName.md new file mode 100644 index 0000000..9d83e3b --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-properties/displayName.md @@ -0,0 +1 @@ +Get Properties \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/get-property/description.md b/services/grouping-and-mapping/v1/operations/get-property/description.md new file mode 100644 index 0000000..f976779 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-property/description.md @@ -0,0 +1,19 @@ +--- + +Retrieves a property. If group is a table, then property of that group is a column. + +Property values are assigned during data extraction. To start the data extraction use [Run Extraction](/apis/insights/operations/run-extraction) operation. + +{!MappingECProperties.md!} + +{!CalculationTypes.md!} + +{!CustomCalculations.md!} + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/get-property/displayName.md b/services/grouping-and-mapping/v1/operations/get-property/displayName.md new file mode 100644 index 0000000..3465852 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/get-property/displayName.md @@ -0,0 +1 @@ +Get Property \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/run-extraction/description.md b/services/grouping-and-mapping/v1/operations/run-extraction/description.md new file mode 100644 index 0000000..13be8ce --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/run-extraction/description.md @@ -0,0 +1,24 @@ +--- + +Run extraction of data from an iModel. This operation has two optional request body parameters: `changesetId` and `ecInstanceIds`. If `ecInstanceIds` are provided, only the ECInstances specified will be extracted. You can provide `changesetId` to run the extraction on a specific [changeset](https://www.itwinjs.org/learning/glossary/#changeset). + +If you do not provide the optional request body parameters: + +- latest changeset will be used for extraction +- all ECInstances will be extracted that are selected by the group queries + +{!ExtractionTriggersAndConfiguration.md!} + +### Notes + +Data will not be extracted for a mapping if that mapping was already extracted from a newer changeset. If you wish to "go back in time" with a mapping and extract data from an older changeset, you will need to copy the mapping and run extraction on the copy. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +{!ExtractionRowLimiting.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/run-extraction/displayName.md b/services/grouping-and-mapping/v1/operations/run-extraction/displayName.md new file mode 100644 index 0000000..bc3d0f5 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/run-extraction/displayName.md @@ -0,0 +1 @@ +Run Extraction \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/update-group/description.md b/services/grouping-and-mapping/v1/operations/update-group/description.md new file mode 100644 index 0000000..4505535 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/update-group/description.md @@ -0,0 +1,15 @@ +--- + +Updates a group. + +{!GroupQuery.md!} + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +{!ExtractionRowLimiting.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/update-group/displayName.md b/services/grouping-and-mapping/v1/operations/update-group/displayName.md new file mode 100644 index 0000000..2c798a5 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/update-group/displayName.md @@ -0,0 +1 @@ +Update Group \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/update-mapping/description.md b/services/grouping-and-mapping/v1/operations/update-mapping/description.md new file mode 100644 index 0000000..8e432dc --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/update-mapping/description.md @@ -0,0 +1,15 @@ +--- + +Updates a mapping. + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!ExtractionTriggersAndConfiguration.md!} + +{!RateLimits.md!} + +{!ExtractionRowLimiting.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/update-mapping/displayName.md b/services/grouping-and-mapping/v1/operations/update-mapping/displayName.md new file mode 100644 index 0000000..1eec185 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/update-mapping/displayName.md @@ -0,0 +1 @@ +Update Mapping \ No newline at end of file diff --git a/services/grouping-and-mapping/v1/operations/update-property/description.md b/services/grouping-and-mapping/v1/operations/update-property/description.md new file mode 100644 index 0000000..88f90de --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/update-property/description.md @@ -0,0 +1,27 @@ +--- + +Updates a property. If group is a table, then property of that group is a column. Properties can be mapped from existing iModel ECProperties, calculated using a predefined list of calculations, or calculated using your own mathematical formula. + +Source of the property value in the output is defined by the `ecProperties`, `calculatedPropertyType`, and `formula` values on a property. You can provide any combination of these properties. If you do not provided any of them, the output value will always be null. Such properties can be used as placeholders or to define an output schema before any property mapping is done. However, when you provide 2 or more of these properties they are evaluated in this order until a valid value (not null or undefined) is found: + +1. `ecProperties` +2. `calculatedPropertyType` +3. `formula` + +Property values are assigned during data extraction. To start the data extraction use [Run Extraction](/apis/insights/operations/run-extraction) operation. + +{!MappingECProperties.md!} + +{!CalculationTypes.md!} + +{!CustomCalculations.md!} + +{!Authorization.md!} + +{!GroupingAndMappingPermissions.md!} + +{!RateLimits.md!} + +{!ExtractionRowLimiting.md!} + +--- diff --git a/services/grouping-and-mapping/v1/operations/update-property/displayName.md b/services/grouping-and-mapping/v1/operations/update-property/displayName.md new file mode 100644 index 0000000..cf5dfe0 --- /dev/null +++ b/services/grouping-and-mapping/v1/operations/update-property/displayName.md @@ -0,0 +1 @@ +Update Property \ No newline at end of file diff --git a/services/imodel-rpc/v1/operations/rpc-version-get/description.md b/services/imodel-rpc/v1/operations/rpc-version-get/description.md new file mode 100644 index 0000000..e69de29 diff --git a/services/imodel-rpc/v1/operations/rpc-version-get/displayName.md b/services/imodel-rpc/v1/operations/rpc-version-get/displayName.md new file mode 100644 index 0000000..ccdc968 --- /dev/null +++ b/services/imodel-rpc/v1/operations/rpc-version-get/displayName.md @@ -0,0 +1 @@ +RPC GET with version \ No newline at end of file diff --git a/services/imodel-rpc/v1/operations/rpc-version/description.md b/services/imodel-rpc/v1/operations/rpc-version/description.md new file mode 100644 index 0000000..e69de29 diff --git a/services/imodel-rpc/v1/operations/rpc-version/displayName.md b/services/imodel-rpc/v1/operations/rpc-version/displayName.md new file mode 100644 index 0000000..e7f3b7c --- /dev/null +++ b/services/imodel-rpc/v1/operations/rpc-version/displayName.md @@ -0,0 +1 @@ +RPC with version \ No newline at end of file diff --git a/services/imodels-odata/v1/description.md b/services/imodels-odata/v1/description.md new file mode 100644 index 0000000..bce9736 --- /dev/null +++ b/services/imodels-odata/v1/description.md @@ -0,0 +1 @@ +Access iModels data using OData v4 interface \ No newline at end of file diff --git a/services/imodels-odata/v1/operations/mapping-odata-entity/description.md b/services/imodels-odata/v1/operations/mapping-odata-entity/description.md new file mode 100644 index 0000000..63ebe9c --- /dev/null +++ b/services/imodels-odata/v1/operations/mapping-odata-entity/description.md @@ -0,0 +1,17 @@ +--- + +Lists the data for a Group and selected Properties. + +iModel Mappings can be managed using [Reporting API](/apis/insights/). + +{!MappingSupport.md!} + +{!OData.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels-odata/v1/operations/mapping-odata-entity/displayName.md b/services/imodels-odata/v1/operations/mapping-odata-entity/displayName.md new file mode 100644 index 0000000..0a6db6f --- /dev/null +++ b/services/imodels-odata/v1/operations/mapping-odata-entity/displayName.md @@ -0,0 +1 @@ +OData Entity \ No newline at end of file diff --git a/services/imodels-odata/v1/operations/mapping-odata-metadata/description.md b/services/imodels-odata/v1/operations/mapping-odata-metadata/description.md new file mode 100644 index 0000000..ca54114 --- /dev/null +++ b/services/imodels-odata/v1/operations/mapping-odata-metadata/description.md @@ -0,0 +1,17 @@ +--- + +Retrieves Definitions of an iModel Mapping. + +iModel Mappings can be managed using [Reporting API](/apis/insights/). + +{!MappingSupport.md!} + +{!OData.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels-odata/v1/operations/mapping-odata-metadata/displayName.md b/services/imodels-odata/v1/operations/mapping-odata-metadata/displayName.md new file mode 100644 index 0000000..627a7b7 --- /dev/null +++ b/services/imodels-odata/v1/operations/mapping-odata-metadata/displayName.md @@ -0,0 +1 @@ +OData Metadata \ No newline at end of file diff --git a/services/imodels-odata/v1/operations/mapping-odata/description.md b/services/imodels-odata/v1/operations/mapping-odata/description.md new file mode 100644 index 0000000..7a1670a --- /dev/null +++ b/services/imodels-odata/v1/operations/mapping-odata/description.md @@ -0,0 +1,17 @@ +--- + +Retrieves all Groups (OData Entities) of an iModel Mapping. This endpoint can be used as an OData feed. + +iModel Mappings can be managed using [Reporting API](/apis/insights/). + +{!MappingSupport.md!} + +{!OData.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels-odata/v1/operations/mapping-odata/displayName.md b/services/imodels-odata/v1/operations/mapping-odata/displayName.md new file mode 100644 index 0000000..52fc7f5 --- /dev/null +++ b/services/imodels-odata/v1/operations/mapping-odata/displayName.md @@ -0,0 +1 @@ +OData \ No newline at end of file diff --git a/services/imodels/v2/description.md b/services/imodels/v2/description.md new file mode 100644 index 0000000..d4f0145 --- /dev/null +++ b/services/imodels/v2/description.md @@ -0,0 +1,5 @@ +iModelHub is the control center for iModels. It is responsible for coordinating concurrent access to iModels as well as changes made to them in a form of [Changesets](https://www.itwinjs.org/learning/glossary/#changeset). + +Overview of [iModelHub](https://www.itwinjs.org/learning/imodelhub/) and [iModels](https://www.itwinjs.org/learning/imodels/). + +These APIs lets you retrieve metadata about the iModels pushed to iModelHub. To view, create or update your iModels use [iTwin.js](https://www.itwinjs.org/) client libraries. diff --git a/services/imodels/v2/operations/acquire-imodel-briefcase/description.md b/services/imodels/v2/operations/acquire-imodel-briefcase/description.md new file mode 100644 index 0000000..1b7681b --- /dev/null +++ b/services/imodels/v2/operations/acquire-imodel-briefcase/description.md @@ -0,0 +1,17 @@ +--- + +Acquires a new [Briefcase](https://www.itwinjs.org/learning/glossary/#briefcase). + +Briefcases are the local copies of iModel that users can acquire to work with the iModel. Users can make changes to their copy of iModel and then push them as a single Changeset file into iModelHub. For more information on Briefcases see [working with Briefcases](https://www.itwinjs.org/learning/imodelhub/briefcases/). + +**Note:** The total number of Briefcases a single user can acquire is limited. The error code `ResourceQuotaExceeded` is returned when you exceed the limit. The current limit is 100 total briefcases. + +The number of Briefcases a single user can acquire per minute is also limited. The error code `RateLimitExceeded` is returned when you exceed the limit. The current limit per minute is 100. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/acquire-imodel-briefcase/displayName.md b/services/imodels/v2/operations/acquire-imodel-briefcase/displayName.md new file mode 100644 index 0000000..7b5cb54 --- /dev/null +++ b/services/imodels/v2/operations/acquire-imodel-briefcase/displayName.md @@ -0,0 +1 @@ +Acquire iModel Briefcase \ No newline at end of file diff --git a/services/imodels/v2/operations/clone-imodel/description.md b/services/imodels/v2/operations/clone-imodel/description.md new file mode 100644 index 0000000..579e6c5 --- /dev/null +++ b/services/imodels/v2/operations/clone-imodel/description.md @@ -0,0 +1,48 @@ +--- + +Clones the specified iModel. + +Cloning an iModel means that a new iModel is created by importing data from the source iModel. That new iModel is considered to be an iModel clone. Id of the source iModel is specified in the request url while the id of the target iTwin which will contain the new iModel is specified in the request body. + +### Relationship between the source iModel and the iModel clone + +iModel clone is a valid standalone iModel. After the iModel cloning process is completed, no new changes are synchronized to the iModel clone from the source iModel. iModel clone is not deleted if the source iModel is deleted. + +### iModel clone content and metadata + +The target iModel name and description can be specified when cloning an iModel, by default name and description are taken from the source iModel. iModel extent is always taken from the source iModel. + +[iModel Baseline](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-baseline-file-details/) is always copied from the source iModel to the target iModel. User can specify until which point [Changesets](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-changesets/) should be copied to the target iModel, by default all source iModel Changesets are copied. The rest of source iModel entities are not copied. + +### Operation state + +Clone iModel is an asynchronous operation. To check the status of the operation please follow the link present in `Create-iModel-Operation` response header. The link points to [Get Create iModel Operation details](https://developer.bentley.com/apis/imodels-v2/operations/get-create-imodel-operation-details/) endpoint of the target iModel. When the target iModel's Create Operation `state` property is set to `successful` it means the cloning process is complete and iModel is ready to be used. + +`Location` header value is a link to [Get iModel details](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-details/) endpoint of the target iModel which provides metadata about the the target iModel as well as when it is ready to be used. When target iModel's `state` property is set to `initialized` the iModel is ready to be used. + +Please note that iModel may be marked as `initialized` before the iModel Create Operation is marked as `successful`. Such behavior allows target iModel to be utilized faster. The cloning background process first of all copies the critical iModel data and marks the iModel as `initialized`, and then copies additional data used to improve performance for iModel viewing and authoring workflows. + +{!Authorization.md!} + +### Authorization + +User must have the following permissions: +- `imodels_manage` permission at the source iModel iTwin level. +- `imodels_manage` permission at the target iTwin level. + +If source iModel has iModel level permissions configured, then user must have at least `imodels_webview` permission assigned at iModel level. + +Alternatively the user should be an Organization Administrator both for the Organization that owns source iModel iTwin and the Organization that owns target iTwin. + +For more information please refer to [Account Administrator](https://developer.bentley.com/apis/access-control-v2/overview/#accountadministrator) documentation section on Access Control API documentation page. + +### Rate limits + +This operation has a lower rate limit than the rest of iModels API operations. If an application exceeds the rate limit it will receive an HTTP error code 429 "Too Many Requests". The error response includes a Retry-After header that indicates how long clients should wait before retrying. + +| Tier | Rate limit | +| -------------------------- | ------------------- | +| Trial | 5 calls per minute | +| Basic, Premium, Enterprise | 20 calls per minute | +
+--- diff --git a/services/imodels/v2/operations/clone-imodel/displayName.md b/services/imodels/v2/operations/clone-imodel/displayName.md new file mode 100644 index 0000000..fccc546 --- /dev/null +++ b/services/imodels/v2/operations/clone-imodel/displayName.md @@ -0,0 +1 @@ +Clone iModel \ No newline at end of file diff --git a/services/imodels/v2/operations/complete-imodel-baseline-file-upload/description.md b/services/imodels/v2/operations/complete-imodel-baseline-file-upload/description.md new file mode 100644 index 0000000..4f5d719 --- /dev/null +++ b/services/imodels/v2/operations/complete-imodel-baseline-file-upload/description.md @@ -0,0 +1,13 @@ +--- + +Complete [iModel](https://www.itwinjs.org/learning/glossary/#imodel) creation from Baseline File by confirming that file was uploaded to file storage. + + Baseline File is the base iModel file that does not have any changesets applied. For creating an iModel from a custom Baseline File see [Create iModel using a Baseline File](https://developer.bentley.com/apis/imodels-v2/operations/create-imodel/#createanimodelusingabaselinefile). + +{!Authorization.md!} + +{!iModelsiTwinPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/complete-imodel-baseline-file-upload/displayName.md b/services/imodels/v2/operations/complete-imodel-baseline-file-upload/displayName.md new file mode 100644 index 0000000..3960be0 --- /dev/null +++ b/services/imodels/v2/operations/complete-imodel-baseline-file-upload/displayName.md @@ -0,0 +1 @@ +Complete iModel Baseline File Upload \ No newline at end of file diff --git a/services/imodels/v2/operations/create-imodel-changeset-extended-data/description.md b/services/imodels/v2/operations/create-imodel-changeset-extended-data/description.md new file mode 100644 index 0000000..4bd2b77 --- /dev/null +++ b/services/imodels/v2/operations/create-imodel-changeset-extended-data/description.md @@ -0,0 +1,15 @@ +--- + +Adds application specific data to the specified [Changeset](https://www.itwinjs.org/learning/glossary/#changeset). + +Extended data is an application specific data associated to the Changeset. This data is not interpreted by the service. Extended data must be a valid json object encoded as base64 string. + +Extended data can only be set once by the principal who created the Changeset. Maximum supported data field size is 204800 bytes (200 KiB). + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/create-imodel-changeset-extended-data/displayName.md b/services/imodels/v2/operations/create-imodel-changeset-extended-data/displayName.md new file mode 100644 index 0000000..bf483d1 --- /dev/null +++ b/services/imodels/v2/operations/create-imodel-changeset-extended-data/displayName.md @@ -0,0 +1 @@ +Create Changeset Extended Data \ No newline at end of file diff --git a/services/imodels/v2/operations/create-imodel-changeset-group/description.md b/services/imodels/v2/operations/create-imodel-changeset-group/description.md new file mode 100644 index 0000000..9ff4892 --- /dev/null +++ b/services/imodels/v2/operations/create-imodel-changeset-group/description.md @@ -0,0 +1,21 @@ +--- + +Creates a new Changeset Group. + +Changeset Groups are a way to logically group [Changesets](https://www.itwinjs.org/learning/glossary/#changeset). Changesets that belong to the same Changeset Group may be interpreted as one logical change to the iModel, for example, iModel synchronization process may create multiple Changesets but they all represent one synchronization run. + +The intended workflow is as follows: + +1. Application creates a Changeset Group. + +2. Application pushes one or more Changesets to that Changeset Group by setting `groupId` property on the Changeset entity. + +3. [Application updates Changeset Group](https://developer.bentley.com/apis/imodels-v2/operations/update-imodel-changeset-group/) and sets its `state` value to `completed`. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/create-imodel-changeset-group/displayName.md b/services/imodels/v2/operations/create-imodel-changeset-group/displayName.md new file mode 100644 index 0000000..b265e6a --- /dev/null +++ b/services/imodels/v2/operations/create-imodel-changeset-group/displayName.md @@ -0,0 +1 @@ +Create iModel Changeset Group \ No newline at end of file diff --git a/services/imodels/v2/operations/create-imodel-changeset/description.md b/services/imodels/v2/operations/create-imodel-changeset/description.md new file mode 100644 index 0000000..eba5b11 --- /dev/null +++ b/services/imodels/v2/operations/create-imodel-changeset/description.md @@ -0,0 +1,28 @@ +--- + +Creates the metadata of a [Changeset](https://www.itwinjs.org/learning/glossary/#changeset). + +For more information on creating and retrieving Changesets using iTwin.js see [working with Changesets](https://www.itwinjs.org/learning/imodelhub/briefcases/). + + **Important: This operation should only be used by iTwin.js. For creating and uploading a valid Changeset please use iTwin.js libraries.** + +Pushing a Changeset consists of three steps: + +1. Create Changeset metadata. +2. Upload Changeset file to blob storage using `upload` property link from the response of Changeset metadata creation. +``` +Request syntax: + PUT upload HTTP/1.1 +Request headers: + x-ms-blob-type: BlockBlob +``` + +3. Complete the Changeset push by confirming that Changeset file was uploaded successfully. See [Update iModel Changeset](https://developer.bentley.com/apis/imodels-v2/operations/update-imodel-changeset/) operation for the documentation. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/create-imodel-changeset/displayName.md b/services/imodels/v2/operations/create-imodel-changeset/displayName.md new file mode 100644 index 0000000..3b57a09 --- /dev/null +++ b/services/imodels/v2/operations/create-imodel-changeset/displayName.md @@ -0,0 +1 @@ +Create iModel Changeset \ No newline at end of file diff --git a/services/imodels/v2/operations/create-imodel-named-version/description.md b/services/imodels/v2/operations/create-imodel-named-version/description.md new file mode 100644 index 0000000..2f2a371 --- /dev/null +++ b/services/imodels/v2/operations/create-imodel-named-version/description.md @@ -0,0 +1,13 @@ +--- + +Create a [Named Version](https://www.itwinjs.org/learning/glossary/#namedversion). + +Every [Changeset](https://www.itwinjs.org/learning/glossary/#changeset) on the timeline creates a new version of the iModel. However, some points on the timeline can represent important milestones or significant events to be saved. iModelHub provides a way to mark a point on the timeline with a name. These time points are referred to as Named Versions. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/create-imodel-named-version/displayName.md b/services/imodels/v2/operations/create-imodel-named-version/displayName.md new file mode 100644 index 0000000..9c96421 --- /dev/null +++ b/services/imodels/v2/operations/create-imodel-named-version/displayName.md @@ -0,0 +1 @@ +Create iModel Named Version \ No newline at end of file diff --git a/services/imodels/v2/operations/create-imodel-share/description.md b/services/imodels/v2/operations/create-imodel-share/description.md new file mode 100644 index 0000000..70d44ab --- /dev/null +++ b/services/imodels/v2/operations/create-imodel-share/description.md @@ -0,0 +1,18 @@ +--- + +Creates a new Share to allow public iModel access. + +iModels Share API provides a way to publicly share an iModel. Each Share instance has a `shareKey` property which allows anonymous access to the shared iModel using iModels API. +To use the `shareKey` to access the iModel one has to provide `shareKey` via `Authorization` header: `Authorization: Basic {shareKey}`, when calling iModels API. + +All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API. + +{!Authorization.md!} + +{!iModelsiTwinPermissions.md!} + +**Important**: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API. + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/create-imodel-share/displayName.md b/services/imodels/v2/operations/create-imodel-share/displayName.md new file mode 100644 index 0000000..8a84725 --- /dev/null +++ b/services/imodels/v2/operations/create-imodel-share/displayName.md @@ -0,0 +1 @@ +Create iModel Share \ No newline at end of file diff --git a/services/imodels/v2/operations/create-imodel/description.md b/services/imodels/v2/operations/create-imodel/description.md new file mode 100644 index 0000000..3b6c05b --- /dev/null +++ b/services/imodels/v2/operations/create-imodel/description.md @@ -0,0 +1,44 @@ +--- + +Creates an [iModel](https://www.itwinjs.org/learning/glossary/#imodel). +There are three different ways to create an iModel. + +### Create an empty iModel + To create an empty iModel do not provide `template` and `baselineFile` properties. + +### Create an iModel from an existing iModel + To create an iModel from another iModel provide `template` property. The server will apply changesets up to the one specified by `changesetId` property to the source iModel file and use it as a Baseline File for the newly created iModel. User must have `imodels_read` permissions to the source iModel. Source and target iTwins must be in the same data center. + +### Create an iModel using a Baseline File. +Creating an iModel using a Baseline File allows to upload a custom iModel file that will become the base file of the created iModel. There are three steps in creating an iModel from a Baseline File: + +1. Create a new iModel and provide `baselineFile` property. **It is important to provide correct file size or the iModel creation will fail in the later steps.** + +2. Upload Baseline File to blob storage using `upload` property link from the response of iModel creation. +``` +Request syntax: + PUT upload HTTP/1.1 +Request headers: + x-ms-blob-type: BlockBlob +``` + +3. Complete the iModel creation by confirming that Baseline File was uploaded successfully. See [Complete iModel Baseline Upload](https://developer.bentley.com/apis/imodels-v2/operations/complete-imodel-baseline-file-upload/) operation for the documentation. + +### iModel initialization + +When creating an empty iModel it will be initialized immediately. When creating an iModel using `template` or `baselineFile` properties initialization will be scheduled and it's state is reflected in the `state` property. For a more detailed information about initialization state see [Get iModel Baseline File](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-baseline-file-details/) operation. + +{!Authorization.md!} + +{!iModelsiTwinPermissions.md!} + +### Rate limits + +This operation has a lower rate limit than the rest of iModels API operations. If an application exceeds the rate limit it will receive an HTTP error code 429 "Too Many Requests". The error response includes a Retry-After header that indicates how long clients should wait before retrying. + +| Tier | Rate limit | +| -------------------------- | ------------------- | +| Trial | 5 calls per minute | +| Basic, Premium, Enterprise | 50 calls per minute | +
+--- \ No newline at end of file diff --git a/services/imodels/v2/operations/create-imodel/displayName.md b/services/imodels/v2/operations/create-imodel/displayName.md new file mode 100644 index 0000000..45f7cc1 --- /dev/null +++ b/services/imodels/v2/operations/create-imodel/displayName.md @@ -0,0 +1 @@ +Create iModel \ No newline at end of file diff --git a/services/imodels/v2/operations/delete-imodel/description.md b/services/imodels/v2/operations/delete-imodel/description.md new file mode 100644 index 0000000..4cdf68b --- /dev/null +++ b/services/imodels/v2/operations/delete-imodel/description.md @@ -0,0 +1,11 @@ +--- + +Deletes [iModel](https://www.itwinjs.org/learning/glossary/#imodel). + +{!Authorization.md!} + +{!iModelsiTwinPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/delete-imodel/displayName.md b/services/imodels/v2/operations/delete-imodel/displayName.md new file mode 100644 index 0000000..81569ac --- /dev/null +++ b/services/imodels/v2/operations/delete-imodel/displayName.md @@ -0,0 +1 @@ +Delete iModel \ No newline at end of file diff --git a/services/imodels/v2/operations/fork-imodel/description.md b/services/imodels/v2/operations/fork-imodel/description.md new file mode 100644 index 0000000..b8b912a --- /dev/null +++ b/services/imodels/v2/operations/fork-imodel/description.md @@ -0,0 +1,52 @@ +--- + +Creates an iModel fork. An iModel fork is a new iModel which is a full or partial clone of the main (source) iModel, but the difference between an iModel fork and an iModel clone is that forks can be edited and then merged back to the main iModel using [Merge iModel transformation](https://developer.bentley.com/apis/transformations/operations/mergeimodel/). + +### Relationship between main and fork iModels + +An iModel fork is a valid standalone iModel. An iModel fork is not deleted if the main iModel is deleted. + +When the iModel forking process is completed, no new changes are synchronized to the iModel fork from the main iModel. + +[iModel Create Operation Details](https://dev-developer.bentley.com/apis/imodels-v2/operations/get-create-imodel-operation-details/) operation can be used to determine if the current iModel is a fork. + +### iModel fork content and metadata + +The iModel fork name and description can be specified when forking an iModel, by default name and description are taken from the main iModel. iModel extent is always taken from the main iModel. + +[iModel Baseline](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-baseline-file-details/) is always copied from the main iModel to the iModel fork. User can specify until which point [Changesets](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-changesets/) should be copied to the iModel fork, by default all main iModel Changesets are copied. The rest of main iModel entities are not copied. + +### Operation state + +Forking an iModel is an asynchronous operation. To check the status of the operation please follow the link present in `Create-iModel-Operation` response header. The link points to [Get Create iModel Operation details](https://developer.bentley.com/apis/imodels-v2/operations/get-create-imodel-operation-details/) endpoint of the iModel fork. When the iModel fork's Create Operation `state` property is set to `successful` it means the forking process is complete and iModel is ready to be used. + +#### `mainIModelIsMissingFederationGuids` state + +If `state` returned by [Get Create iModel Operation details](https://developer.bentley.com/apis/imodels-v2/operations/get-create-imodel-operation-details/) is equal to `mainIModelIsMissingFederationGuids`, it means that iModel fork creation failed because some elements in the main iModel do not have [FederationGuid](https://www.itwinjs.org/bis/guide/fundamentals/federationguids/) property set. In order to proceed users must populate missing FederationGuid values in main iModel using [Populate Federation Guids transformation](https://developer.bentley.com/apis/transformations/operations/populatefederationguids/) and retry the iModel fork creation request. + +{!Authorization.md!} + +### Authorization + +User must have the following permissions: +- `imodels_manage` permission at the main iModel iTwin level. +- `imodels_manage` permission at the iTwin, in which the iModel fork will be created, level. + +If main iModel has iModel level permissions configured, then user must have at least `imodels_webview` permission assigned. + +Alternatively the user should be an Organization Administrator both for the Organization that owns main iModel iTwin and the Organization that owns the iModel fork iTwin. + +For more information please refer to [Account Administrator](https://developer.bentley.com/apis/access-control-v2/overview/#accountadministrator) documentation section on Access Control API documentation page. + +**Important**: Fork iModel operation is in closed preview mode currently and only selected applications can utilize it. + +### Rate limits + +This operation has a lower rate limit than the rest of iModels API operations. If an application exceeds the rate limit it will receive an HTTP error code 429 "Too Many Requests". The error response includes a Retry-After header that indicates how long clients should wait before retrying. + +| Tier | Rate limit | +| -------------------------- | ------------------- | +| Trial | 5 calls per minute | +| Basic, Premium, Enterprise | 20 calls per minute | +
+--- diff --git a/services/imodels/v2/operations/fork-imodel/displayName.md b/services/imodels/v2/operations/fork-imodel/displayName.md new file mode 100644 index 0000000..4d17fdb --- /dev/null +++ b/services/imodels/v2/operations/fork-imodel/displayName.md @@ -0,0 +1 @@ +Fork iModel \ No newline at end of file diff --git a/services/imodels/v2/operations/get-briefcase-checkpoint/description.md b/services/imodels/v2/operations/get-briefcase-checkpoint/description.md new file mode 100644 index 0000000..4a7f49a --- /dev/null +++ b/services/imodels/v2/operations/get-briefcase-checkpoint/description.md @@ -0,0 +1,20 @@ +--- + +Returns latest Checkpoint for an iModel. Checkpoint is a pre-processed iModel baseline file that has changes up to a certain Changeset already applied and is stored on the server. This can be used to reduce number of Changesets needed to apply to get to a certain version of the iModel. + +A Checkpoint is generated when a Named Version is created for that changeset. + +Checkpoint can be stored in two different ways: + +1. `download` property will have a Azure Blob storage link to a full `.bim` file that has changes applied up to the Changeset specified by `changesetIndex` and `changesetId` properties. +2. `containerAccessInfo` will have an access key to Azure Blob container that stores the Checkpoint in 4 MB blocks. **Important: This property should only be used by iTwin.js libraries.** + +A successfully generated Checkpoint will have one or both of these properties. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-briefcase-checkpoint/displayName.md b/services/imodels/v2/operations/get-briefcase-checkpoint/displayName.md new file mode 100644 index 0000000..df1421c --- /dev/null +++ b/services/imodels/v2/operations/get-briefcase-checkpoint/displayName.md @@ -0,0 +1 @@ +Get Briefcase Checkpoint \ No newline at end of file diff --git a/services/imodels/v2/operations/get-changeset-checkpoint/description.md b/services/imodels/v2/operations/get-changeset-checkpoint/description.md new file mode 100644 index 0000000..e6e2954 --- /dev/null +++ b/services/imodels/v2/operations/get-changeset-checkpoint/description.md @@ -0,0 +1,20 @@ +--- + +Returns Checkpoint associated with the provided Changeset. Checkpoint is a pre-processed iModel baseline file that has changes up to a certain Changeset already applied and is stored on the server. This can be used to reduce number of Changesets needed to apply to get to a certain version of the iModel. + +A Checkpoint is generated when a Named Version is created for that changeset. + +Checkpoint can be stored in two different ways: + +1. `download` property will have a Azure Blob storage link to a full `.bim` file that has changes applied up to the Changeset specified by `changesetIndex` and `changesetId` properties. +2. `containerAccessInfo` will have an access key to Azure Blob container that stores the Checkpoint in 4 MB blocks. **Important: This property should only be used by iTwin.js libraries.** + +A successfully generated Checkpoint will have one or both of these properties. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-changeset-checkpoint/displayName.md b/services/imodels/v2/operations/get-changeset-checkpoint/displayName.md new file mode 100644 index 0000000..9e7ed46 --- /dev/null +++ b/services/imodels/v2/operations/get-changeset-checkpoint/displayName.md @@ -0,0 +1 @@ +Get Changeset Checkpoint \ No newline at end of file diff --git a/services/imodels/v2/operations/get-create-imodel-operation-details/description.md b/services/imodels/v2/operations/get-create-imodel-operation-details/description.md new file mode 100644 index 0000000..619ec41 --- /dev/null +++ b/services/imodels/v2/operations/get-create-imodel-operation-details/description.md @@ -0,0 +1,21 @@ +--- + +Returns the information about iModel creation process. + +This endpoint should be used to check if iModel creation completed. + +### Forked and cloned iModels + +When an iModel is a clone, the `clonedFrom` response entity property will contain information about the source iModel from which this iModel was created, otherwise it will be `null`. For more information on iModel cloning please refer to the [Clone iModel](https://developer.bentley.com/apis/imodels-v2/operations/clone-imodel/) operation documentation. + +When an iModel is a fork, the `forkedFrom` response entity property will contain information about the main iModel from which this iModel was created, otherwise it will be `null`. For more information on iModel forking please refer to the [Fork iModel](https://developer.bentley.com/apis/imodels-v2/operations/fork-imodel/) operation documentation. + +To get the details of the source/main iModel use [Get iModel Details](https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-details/) operation with id value taken from `clonedFrom.iModelId` or `forkedFrom.iModelId`. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-create-imodel-operation-details/displayName.md b/services/imodels/v2/operations/get-create-imodel-operation-details/displayName.md new file mode 100644 index 0000000..1128642 --- /dev/null +++ b/services/imodels/v2/operations/get-create-imodel-operation-details/displayName.md @@ -0,0 +1 @@ +Get Create iModel Operation Details \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-baseline-file-details/description.md b/services/imodels/v2/operations/get-imodel-baseline-file-details/description.md new file mode 100644 index 0000000..153e6fa --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-baseline-file-details/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves the metadata of a Baseline File. Baseline File is the base iModel file that does not have any changesets applied. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +**Note:** `download` property requires user to have at least `imodels_read` permission. If user has only `imodels_webview` permission `download` will always be null. + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-baseline-file-details/displayName.md b/services/imodels/v2/operations/get-imodel-baseline-file-details/displayName.md new file mode 100644 index 0000000..6849784 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-baseline-file-details/displayName.md @@ -0,0 +1 @@ +Get iModel Baseline File Details \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-briefcase-details/description.md b/services/imodels/v2/operations/get-imodel-briefcase-details/description.md new file mode 100644 index 0000000..c578bb9 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-briefcase-details/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves the details of a [Briefcase](https://www.itwinjs.org/learning/glossary/#briefcase). + +Briefcases are the local copies of iModel that users can acquire to work with the iModel. Users can make changes to their copy of iModel and then push them as a single Changeset file into iModelHub. For more information on Briefcases see [working with Briefcases](https://www.itwinjs.org/learning/imodelhub/briefcases/). + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-briefcase-details/displayName.md b/services/imodels/v2/operations/get-imodel-briefcase-details/displayName.md new file mode 100644 index 0000000..8daee65 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-briefcase-details/displayName.md @@ -0,0 +1 @@ +Get iModel Briefcase \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-briefcases/description.md b/services/imodels/v2/operations/get-imodel-briefcases/description.md new file mode 100644 index 0000000..18fda74 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-briefcases/description.md @@ -0,0 +1,22 @@ +--- + +Retrieves a list of [Briefcases](https://www.itwinjs.org/learning/glossary/#briefcase) for the iModel specified by the iModel id. + +Briefcases are the local copies of iModel that users can acquire to work with the iModel. Users can make changes to their copy of iModel and then push them as a single Changeset file into iModelHub. For more information on Briefcases see [working with Briefcases](https://www.itwinjs.org/learning/imodelhub/briefcases/). + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-briefcases/displayName.md b/services/imodels/v2/operations/get-imodel-briefcases/displayName.md new file mode 100644 index 0000000..1a75f03 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-briefcases/displayName.md @@ -0,0 +1 @@ +Get iModel Briefcases \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-changeset-details/description.md b/services/imodels/v2/operations/get-imodel-changeset-details/description.md new file mode 100644 index 0000000..8128ab6 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changeset-details/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves the metadata of a [Changeset](https://www.itwinjs.org/learning/glossary/#changeset). + +For more information on creating and retrieving Changesets using iTwin.js see [working with Changesets](https://www.itwinjs.org/learning/imodelhub/briefcases/). + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +**Note:** `download` property requires user to have at least `imodels_read` permission. If user has only `imodels_webview` permission `download` will always be null. + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-changeset-details/displayName.md b/services/imodels/v2/operations/get-imodel-changeset-details/displayName.md new file mode 100644 index 0000000..8c9f63e --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changeset-details/displayName.md @@ -0,0 +1 @@ +Get iModel Changeset \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-changeset-extended-data-details/description.md b/services/imodels/v2/operations/get-imodel-changeset-extended-data-details/description.md new file mode 100644 index 0000000..4e29e52 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changeset-extended-data-details/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves the details of a Changesets Extended Data. + +Extended data is an application specific data associated to the [Changeset](https://www.itwinjs.org/learning/glossary/#changeset). This data is not interpreted by the service. Extended data must be a valid json object encoded as base64 string. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-changeset-extended-data-details/displayName.md b/services/imodels/v2/operations/get-imodel-changeset-extended-data-details/displayName.md new file mode 100644 index 0000000..1eb1d7f --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changeset-extended-data-details/displayName.md @@ -0,0 +1 @@ +Get Changeset Extended Data \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-changeset-group-details/description.md b/services/imodels/v2/operations/get-imodel-changeset-group-details/description.md new file mode 100644 index 0000000..100a1a0 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changeset-group-details/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves the details of a Changeset Group. + +Changeset Groups are a way to logically group [Changesets](https://www.itwinjs.org/learning/glossary/#changeset). Changesets that belong to the same Changeset Group may be interpreted as one logical change to the iModel, for example, iModel synchronization process may create multiple Changesets but they all represent one synchronization run. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-changeset-group-details/displayName.md b/services/imodels/v2/operations/get-imodel-changeset-group-details/displayName.md new file mode 100644 index 0000000..f98d9fa --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changeset-group-details/displayName.md @@ -0,0 +1 @@ +Get iModel Changeset Group \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-changeset-groups/description.md b/services/imodels/v2/operations/get-imodel-changeset-groups/description.md new file mode 100644 index 0000000..ad6cd93 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changeset-groups/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves a list of Changeset Groups for the iModel specified by the iModel id. + +Changeset Groups are a way to logically group [Changesets](https://www.itwinjs.org/learning/glossary/#changeset). Changesets that belong to the same Changeset Group may be interpreted as one logical change to the iModel, for example, iModel synchronization process may create multiple Changesets but they all represent one synchronization run. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-changeset-groups/displayName.md b/services/imodels/v2/operations/get-imodel-changeset-groups/displayName.md new file mode 100644 index 0000000..78c19a6 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changeset-groups/displayName.md @@ -0,0 +1 @@ +Get iModel Changeset Groups \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-changesets-extended-data/description.md b/services/imodels/v2/operations/get-imodel-changesets-extended-data/description.md new file mode 100644 index 0000000..7e5dd70 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changesets-extended-data/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves a list of extended Changeset data entries for the iModel specified by the iModel id. + +Extended data is an application specific data associated to the [Changeset](https://www.itwinjs.org/learning/glossary/#changeset). This data is not interpreted by the service. Extended data must be a valid json object encoded as base64 string. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-changesets-extended-data/displayName.md b/services/imodels/v2/operations/get-imodel-changesets-extended-data/displayName.md new file mode 100644 index 0000000..e94e780 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changesets-extended-data/displayName.md @@ -0,0 +1 @@ +Get Changesets Extended Data \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-changesets/description.md b/services/imodels/v2/operations/get-imodel-changesets/description.md new file mode 100644 index 0000000..7d805f3 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changesets/description.md @@ -0,0 +1,25 @@ +--- + +Retrieves a list of [Changesets](https://www.itwinjs.org/learning/glossary/#changeset) for the iModel specified by the iModel id. + +[Changesets](https://www.itwinjs.org/learning/glossary/#changeset) form a linear timeline of the iModel changes. +For more information on creating and retrieving Changesets using iTwin.js see [working with Changesets](https://www.itwinjs.org/learning/imodelhub/briefcases/). + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +**Note:** `download` property requires user to have at least `imodels_read` permission. If user has only `imodels_webview` permission `download` will always be null. + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-changesets/displayName.md b/services/imodels/v2/operations/get-imodel-changesets/displayName.md new file mode 100644 index 0000000..6f1e029 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-changesets/displayName.md @@ -0,0 +1 @@ +Get iModel Changesets \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-details/description.md b/services/imodels/v2/operations/get-imodel-details/description.md new file mode 100644 index 0000000..0bc6b84 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-details/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves the metadata of an [iModel](https://www.itwinjs.org/learning/glossary/#imodel). + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-details/displayName.md b/services/imodels/v2/operations/get-imodel-details/displayName.md new file mode 100644 index 0000000..c7ed40a --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-details/displayName.md @@ -0,0 +1 @@ +Get iModel \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-locks/description.md b/services/imodels/v2/operations/get-imodel-locks/description.md new file mode 100644 index 0000000..39feccb --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-locks/description.md @@ -0,0 +1,18 @@ +--- + +Queries locks of the iModel. +Lock - the right to modify a specific type of data within the iModel. For more information on Locks [see working with Locks via iTwin.js client libraries](https://www.itwinjs.org/learning/backend/concurrencycontrol/#pessimistic-concurrency-control). + +**Note:** Lock types have been removed for this API and should be ignored. + +### Paging + +Page size refers to total size of returned `objectIds` throughout all returned instances. If several Lock instances are returned that does not necessarily mean that instance is complete and more `objectIds` might be returned for that specific instance in a different page. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-locks/displayName.md b/services/imodels/v2/operations/get-imodel-locks/displayName.md new file mode 100644 index 0000000..253e96c --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-locks/displayName.md @@ -0,0 +1 @@ +Get iModel Locks \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-named-version-details/description.md b/services/imodels/v2/operations/get-imodel-named-version-details/description.md new file mode 100644 index 0000000..37a2368 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-named-version-details/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves the details of a Named Version. + +Every [Changeset](https://www.itwinjs.org/learning/glossary/#changeset) on the timeline creates a new version of the iModel. However, some points on the timeline can represent important milestones or significant events to be saved. iModelHub provides a way to mark a point on the timeline with a name. These time points are referred to as Named Versions. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-named-version-details/displayName.md b/services/imodels/v2/operations/get-imodel-named-version-details/displayName.md new file mode 100644 index 0000000..08aadb1 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-named-version-details/displayName.md @@ -0,0 +1 @@ +Get iModel Named Version \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-named-versions/description.md b/services/imodels/v2/operations/get-imodel-named-versions/description.md new file mode 100644 index 0000000..ab7cba3 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-named-versions/description.md @@ -0,0 +1,22 @@ +--- + +Retrieves a list of Named Versions for the iModel specified by the iModel id. + +Every [Changeset](https://www.itwinjs.org/learning/glossary/#changeset) on the timeline creates a new version of the iModel. However, some points on the timeline can represent important milestones or significant events to be saved. iModelHub provides a way to mark a point on the timeline with a name. These time points are referred to as Named Versions. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-named-versions/displayName.md b/services/imodels/v2/operations/get-imodel-named-versions/displayName.md new file mode 100644 index 0000000..8b449a0 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-named-versions/displayName.md @@ -0,0 +1 @@ +Get iModel Named Versions \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-permissions/description.md b/services/imodels/v2/operations/get-imodel-permissions/description.md new file mode 100644 index 0000000..b962b15 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-permissions/description.md @@ -0,0 +1,21 @@ +--- + +Retrieves a list of permissions the user has for the specified iModel. iModels permissions may be configured on an iTwin level or an iModel level. iModel level permissions can be configured [per role](https://developer.bentley.com/apis/imodels-v2/operations/update-imodel-role-permissions/) or [per user](https://developer.bentley.com/apis/imodels-v2/operations/update-imodel-user-permissions/). This operation will return permissions configured for this specific iModel or iTwin permissions if iModel permissions are not configured. + +`imodels_webview` - allows to view iModel in web browser, but does not allow to get its local copy and view in desktop app. + +`imodels_read` - allows to open and view an iModel only in read-only state. + +`imodels_write` - allows to make changes to an iModel. Allows to create and modify named versions. Allows to create mapping between PW connection and iModel to facilitate bridges. + +`imodels_manage` - allows to create an iModel. Allows to configure access per iModel. Allows to manage locks, codes or local copies for the entire iModel. This permission is both iModel and iTwin level permission, but Create iModel operation requires that user has `imodels_manage` permission on the iTwin level. + +`imodels_delete` - allows to delete an iModel. This permission is only available on the iTwin level. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-permissions/displayName.md b/services/imodels/v2/operations/get-imodel-permissions/displayName.md new file mode 100644 index 0000000..c8c50a1 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-permissions/displayName.md @@ -0,0 +1 @@ +Get iModel Permissions \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-role-permissions/description.md b/services/imodels/v2/operations/get-imodel-role-permissions/description.md new file mode 100644 index 0000000..9fe8b62 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-role-permissions/description.md @@ -0,0 +1,25 @@ +--- + +Retrieves configured RBAC role permissions for the specified iModel. + +Individual iModel permissions allow to have more granular permissions than assigned at iTwin level. This either broadens or shrinks the set of permission the user has at iTwin level. That is, once at least one role permission is configured on the given iModel, then this configuration takes precedence over permissions configured at iTwin level. + +Please refer to [Access Control API](https://developer.bentley.com/apis/access-control-v2/overview/) to learn more about Role Based Access Control principles. + +iModel permissions that could be returned with the configured roles: + +`imodels_webview` - allows to view iModel in web browser, but does not allow to get its local copy and view in desktop app. + +`imodels_read` - allows to open and view an iModel only in read-only state. + +`imodels_write` - allows to make changes to an iModel. Allows to create and modify named versions. Allows to create mapping between PW connection and iModel to facilitate bridges. + +`imodels_manage` - allows to manage locks, codes or local copies for the entire iModel. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-role-permissions/displayName.md b/services/imodels/v2/operations/get-imodel-role-permissions/displayName.md new file mode 100644 index 0000000..afed04c --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-role-permissions/displayName.md @@ -0,0 +1 @@ +Get iModel Role Permissions \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-share/description.md b/services/imodels/v2/operations/get-imodel-share/description.md new file mode 100644 index 0000000..682429a --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-share/description.md @@ -0,0 +1,18 @@ +--- + +Retrieves the details of a Share. + +iModels Share API provides a way to publicly share an iModel. Each Share instance has a `shareKey` property which allows anonymous access to the shared iModel using iModels API. +To use the `shareKey` to access the iModel one has to provide `shareKey` via `Authorization` header: `Authorization: Basic {shareKey}`, when calling iModels API. + +All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +**Important**: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API. + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-share/displayName.md b/services/imodels/v2/operations/get-imodel-share/displayName.md new file mode 100644 index 0000000..e3bdc2c --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-share/displayName.md @@ -0,0 +1 @@ +Get iModel Share \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-shares/description.md b/services/imodels/v2/operations/get-imodel-shares/description.md new file mode 100644 index 0000000..ac550ec --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-shares/description.md @@ -0,0 +1,18 @@ +--- + +Retrieves a list of Shares of the given iModel created by the calling user. + +iModels Share API provides a way to publicly share an iModel. Each Share instance has a `shareKey` property which allows anonymous access to the shared iModel using iModels API. +To use the `shareKey` to access the iModel one has to provide `shareKey` via `Authorization` header: `Authorization: Basic {shareKey}`, when calling iModels API. + +All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +**Important**: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API. + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-shares/displayName.md b/services/imodels/v2/operations/get-imodel-shares/displayName.md new file mode 100644 index 0000000..852ac59 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-shares/displayName.md @@ -0,0 +1 @@ +Get iModel Shares \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-thumbnail/description.md b/services/imodels/v2/operations/get-imodel-thumbnail/description.md new file mode 100644 index 0000000..d2c5b05 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-thumbnail/description.md @@ -0,0 +1,14 @@ +--- + +Retrieves a Thumbnail file. Returned Thumbnail will be 'image/png' type. + + +One may specify either the *small* or *large* Thumbnail via the *size* query parameter. If *size* is not specified, the small Thumbnail will be returned. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-thumbnail/displayName.md b/services/imodels/v2/operations/get-imodel-thumbnail/displayName.md new file mode 100644 index 0000000..0c4fb17 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-thumbnail/displayName.md @@ -0,0 +1 @@ +Download iModel Thumbnail \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-user-details/description.md b/services/imodels/v2/operations/get-imodel-user-details/description.md new file mode 100644 index 0000000..f547157 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-user-details/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves the details about the user. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-user-details/displayName.md b/services/imodels/v2/operations/get-imodel-user-details/displayName.md new file mode 100644 index 0000000..da72a18 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-user-details/displayName.md @@ -0,0 +1 @@ +Get iModel User \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-user-permissions/description.md b/services/imodels/v2/operations/get-imodel-user-permissions/description.md new file mode 100644 index 0000000..18dbc1b --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-user-permissions/description.md @@ -0,0 +1,25 @@ +--- + +Retrieves configured RBAC user permissions for the specified iModel. + +Individual iModel permissions allow to have more granular permissions than assigned at iTwin level. This either broadens or shrinks the set of permission the user has at iTwin level. That is, once at least one user permission is configured on the given iModel, then this configuration takes precedence over permissions configured at iTwin level. + +Please refer to [Access Control API](https://developer.bentley.com/apis/access-control-v2/overview/) to learn more about Role Based Access Control principles. + +iModel permissions that could be returned for the configured users: + +`imodels_webview` - allows to view iModel in web browser, but does not allow to get its local copy and view in desktop app. + +`imodels_read` - allows to open and view an iModel only in read-only state. + +`imodels_write` - allows to make changes to an iModel. Allows to create and modify named versions. Allows to create mapping between PW connection and iModel to facilitate bridges. + +`imodels_manage` - allows to manage locks, codes or local copies for the entire iModel. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-user-permissions/displayName.md b/services/imodels/v2/operations/get-imodel-user-permissions/displayName.md new file mode 100644 index 0000000..c887b03 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-user-permissions/displayName.md @@ -0,0 +1 @@ +Get iModel User Permissions \ No newline at end of file diff --git a/services/imodels/v2/operations/get-imodel-users/description.md b/services/imodels/v2/operations/get-imodel-users/description.md new file mode 100644 index 0000000..23fa801 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-users/description.md @@ -0,0 +1,20 @@ +--- + +Retrieves a list of users who have ever been connected to the iModel specified by the iModel id. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-imodel-users/displayName.md b/services/imodels/v2/operations/get-imodel-users/displayName.md new file mode 100644 index 0000000..c3746b3 --- /dev/null +++ b/services/imodels/v2/operations/get-imodel-users/displayName.md @@ -0,0 +1 @@ +Get iModel Users \ No newline at end of file diff --git a/services/imodels/v2/operations/get-itwin-imodels/description.md b/services/imodels/v2/operations/get-itwin-imodels/description.md new file mode 100644 index 0000000..2f4705f --- /dev/null +++ b/services/imodels/v2/operations/get-itwin-imodels/description.md @@ -0,0 +1,20 @@ +--- + +Retrieves a list of iModels belonging to the specified iTwin. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-itwin-imodels/displayName.md b/services/imodels/v2/operations/get-itwin-imodels/displayName.md new file mode 100644 index 0000000..52ba0ec --- /dev/null +++ b/services/imodels/v2/operations/get-itwin-imodels/displayName.md @@ -0,0 +1 @@ +Get iTwin iModels \ No newline at end of file diff --git a/services/imodels/v2/operations/get-named-version-checkpoint/description.md b/services/imodels/v2/operations/get-named-version-checkpoint/description.md new file mode 100644 index 0000000..cf1131c --- /dev/null +++ b/services/imodels/v2/operations/get-named-version-checkpoint/description.md @@ -0,0 +1,19 @@ +--- + +Returns Checkpoint associated with the provided Named Version. Checkpoint is a pre-processed iModel baseline file that has changes up to a certain Changeset already applied and is stored on the server. This can be used to reduce number of Changesets needed to apply to get to a certain version of the iModel. + +A Checkpoint is generated when a Named Version is created for that changeset. + +Checkpoint can be stored in two different ways: +1. `download` property will have a Azure Blob storage link to a full `.bim` file that has changes applied up to the Changeset specified by `changesetIndex` and `changesetId` properties. +2. `containerAccessInfo` will have an access key to Azure Blob container that stores the Checkpoint in 4 MB blocks. **Important: This property should only be used by iTwin.js libraries.** + +A successfully generated Checkpoint will have one or both of these properties. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/get-named-version-checkpoint/displayName.md b/services/imodels/v2/operations/get-named-version-checkpoint/displayName.md new file mode 100644 index 0000000..3b45d65 --- /dev/null +++ b/services/imodels/v2/operations/get-named-version-checkpoint/displayName.md @@ -0,0 +1 @@ +Get Named Version Checkpoint \ No newline at end of file diff --git a/services/imodels/v2/operations/release-imodel-briefcase/description.md b/services/imodels/v2/operations/release-imodel-briefcase/description.md new file mode 100644 index 0000000..0a0a176 --- /dev/null +++ b/services/imodels/v2/operations/release-imodel-briefcase/description.md @@ -0,0 +1,19 @@ +--- + +Deletes the specified [Briefcase](https://www.itwinjs.org/learning/glossary/#briefcase). + +Briefcases are the local copies of iModel that users can acquire to work with the iModel. Users can make changes to their copy of iModel and then push them as a single Changeset file into iModelHub. For more information on Briefcases see [working with Briefcases](https://www.itwinjs.org/learning/imodelhub/briefcases/). + +{!Authorization.md!} + +### Authorization + +To release any Briefcase user must have `imodels_manage` permission assigned at the iModel level. If permissions at the iModel level are not configured, then user must have `imodels_manage` permission assigned at the iTwin level. To release a Briefcase that the user owns `imodels_webview` permission is enough. + +Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin the iModel belongs to. + +For more information please refer to [Account Administrator](https://developer.bentley.com/apis/access-control-v2/overview/#accountadministrator) documentation section on Access Control API documentation page. + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/release-imodel-briefcase/displayName.md b/services/imodels/v2/operations/release-imodel-briefcase/displayName.md new file mode 100644 index 0000000..d5424d6 --- /dev/null +++ b/services/imodels/v2/operations/release-imodel-briefcase/displayName.md @@ -0,0 +1 @@ +Release iModel Briefcase \ No newline at end of file diff --git a/services/imodels/v2/operations/revoke-imodel-share/description.md b/services/imodels/v2/operations/revoke-imodel-share/description.md new file mode 100644 index 0000000..c5acfa8 --- /dev/null +++ b/services/imodels/v2/operations/revoke-imodel-share/description.md @@ -0,0 +1,18 @@ +--- + +Deletes a Share making the `shareKey` invalid. + +iModels Share API provides a way to publicly share an iModel. Each Share instance has a `shareKey` property which allows anonymous access to the shared iModel using iModels API. +To use the `shareKey` to access the iModel one has to provide `shareKey` via `Authorization` header: `Authorization: Basic {shareKey}`, when calling iModels API. + +All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +**Important**: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API. + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/revoke-imodel-share/displayName.md b/services/imodels/v2/operations/revoke-imodel-share/displayName.md new file mode 100644 index 0000000..65523d9 --- /dev/null +++ b/services/imodels/v2/operations/revoke-imodel-share/displayName.md @@ -0,0 +1 @@ +Revoke iModel Share \ No newline at end of file diff --git a/services/imodels/v2/operations/update-imodel-changeset-group/description.md b/services/imodels/v2/operations/update-imodel-changeset-group/description.md new file mode 100644 index 0000000..73ace25 --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-changeset-group/description.md @@ -0,0 +1,15 @@ +--- + +Closes an existing Changeset Group. + +Please refer to [Create iModel Changeset Group](https://developer.bentley.com/apis/imodels-v2/operations/create-imodel-changeset-group/) operation documentation for information about the purpose of Changeset Groups. + +Closing a Changeset Group means that there will be no more [Changesets](https://www.itwinjs.org/learning/glossary/#changeset) in the logical group, for example, synchronization process has processed all iModel changes and will not push any more Changesets. If a Changeset Group is closed, meaning its `state` property value is `completed`, `timedOut` or `forciblyClosed`, no more Changesets referencing that particular Group will be accepted. Users can only close the Changeset Group by setting `completed` state value as other values are set by iModels API. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/update-imodel-changeset-group/displayName.md b/services/imodels/v2/operations/update-imodel-changeset-group/displayName.md new file mode 100644 index 0000000..12e47c0 --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-changeset-group/displayName.md @@ -0,0 +1 @@ +Update iModel Changeset Group \ No newline at end of file diff --git a/services/imodels/v2/operations/update-imodel-changeset/description.md b/services/imodels/v2/operations/update-imodel-changeset/description.md new file mode 100644 index 0000000..5fe668c --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-changeset/description.md @@ -0,0 +1,11 @@ +--- + +Confirm that [Changeset](https://www.itwinjs.org/learning/glossary/#changeset) file has been uploaded to file storage and finalize Changeset push. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/update-imodel-changeset/displayName.md b/services/imodels/v2/operations/update-imodel-changeset/displayName.md new file mode 100644 index 0000000..8339b60 --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-changeset/displayName.md @@ -0,0 +1 @@ +Update iModel Changeset \ No newline at end of file diff --git a/services/imodels/v2/operations/update-imodel-locks/description.md b/services/imodels/v2/operations/update-imodel-locks/description.md new file mode 100644 index 0000000..fba4fa6 --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-locks/description.md @@ -0,0 +1,22 @@ +--- + +Acquires requested locks on specified objects. +Lock - the right to modify a specific type of data within the iModel. For more information on Locks [see working with Locks via iTwin.js client libraries](https://www.itwinjs.org/learning/backend/concurrencycontrol/#pessimistic-concurrency-control). + +**Note:** Lock types have been removed for this API and should be ignored. + +**Object ids Limit:** Currently there can be at most 1000 object ids in a single request. + +{!Authorization.md!} + +### Authorization + +To release any Locks (set `LockLevel` to `none`) user must have `imodels_manage` permission assigned at the iModel level. If permissions at the iModel level are not configured, then user must have `imodels_manage` permission assigned at the iTwin level. To acquire or realese Locks that the user owns `imodels_write` permission is enough. + +Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin the iModel belongs to. + +For more information please refer to [Account Administrator](https://developer.bentley.com/apis/access-control-v2/overview/#accountadministrator) documentation section on Access Control API documentation page. + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/update-imodel-locks/displayName.md b/services/imodels/v2/operations/update-imodel-locks/displayName.md new file mode 100644 index 0000000..f43ed7a --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-locks/displayName.md @@ -0,0 +1 @@ +Update iModel Locks \ No newline at end of file diff --git a/services/imodels/v2/operations/update-imodel-named-version/description.md b/services/imodels/v2/operations/update-imodel-named-version/description.md new file mode 100644 index 0000000..a4b35d1 --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-named-version/description.md @@ -0,0 +1,13 @@ +--- + +Update metadata of a [Named Version](https://www.itwinjs.org/learning/glossary/#namedversion). + +Every [Changeset](https://www.itwinjs.org/learning/glossary/#changeset) on the timeline creates a new version of the iModel. However, some points on the timeline can represent important milestones or significant events to be saved. iModelHub provides a way to mark a point on the timeline with a name. These time points are referred to as Named Versions. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/update-imodel-named-version/displayName.md b/services/imodels/v2/operations/update-imodel-named-version/displayName.md new file mode 100644 index 0000000..a129693 --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-named-version/displayName.md @@ -0,0 +1 @@ +Update iModel Named Version \ No newline at end of file diff --git a/services/imodels/v2/operations/update-imodel-role-permissions/description.md b/services/imodels/v2/operations/update-imodel-role-permissions/description.md new file mode 100644 index 0000000..d42a86e --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-role-permissions/description.md @@ -0,0 +1,27 @@ +--- + +Configures RBAC role permissions for the individual iModel. Specified permissions are assigned to the provided role. + +Individual iModel permissions allow to have more granular permissions than assigned at iTwin level. This either broadens or shrinks the set of permission the user has at iTwin level. That is, once at least one role permission is configured on the given iModel, then this configuration takes precedence over permissions configured at iTwin level. + +Role and User permissions are mutually exclusive and cannot be configured for an iModel at the same time. + +Please refer to [Access Control API](https://developer.bentley.com/apis/access-control-v2/overview/) to learn more about Role Based Access Control principles in general. + +iModel permissions that could be assigned to the provided role: + +`imodels_webview` - allows to view iModel in web browser, but does not allow to get its local copy and view in desktop app. + +`imodels_read` - allows to open and view an iModel only in read-only state. + +`imodels_write` - allows to make changes to an iModel. Allows to create and modify named versions. Allows to create mapping between PW connection and iModel to facilitate bridges. + +`imodels_manage` - allows to manage locks, codes or local copies for the entire iModel. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/update-imodel-role-permissions/displayName.md b/services/imodels/v2/operations/update-imodel-role-permissions/displayName.md new file mode 100644 index 0000000..29654a4 --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-role-permissions/displayName.md @@ -0,0 +1 @@ +Update iModel Role Permissions \ No newline at end of file diff --git a/services/imodels/v2/operations/update-imodel-share/description.md b/services/imodels/v2/operations/update-imodel-share/description.md new file mode 100644 index 0000000..f7e52c0 --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-share/description.md @@ -0,0 +1,18 @@ +--- + +Extend the expiration date of a Share. + +iModels Share API provides a way to publicly share an iModel. Each Share instance has a `shareKey` property which allows anonymous access to the shared iModel using iModels API. +To use the `shareKey` to access the iModel one has to provide `shareKey` via `Authorization` header: `Authorization: Basic {shareKey}`, when calling iModels API. + +All Share operations interact only with the Share instances that the calling user has created. E.g. querying iModel Shares will not return all the Shares iModel has, but only the Shares which were created by the user who is calling the API. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +**Important**: Share operations are in closed preview mode currently. Hence only selected applications can utilize the Share API. + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/update-imodel-share/displayName.md b/services/imodels/v2/operations/update-imodel-share/displayName.md new file mode 100644 index 0000000..8df9893 --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-share/displayName.md @@ -0,0 +1 @@ +Update iModel Share \ No newline at end of file diff --git a/services/imodels/v2/operations/update-imodel-user-permissions/description.md b/services/imodels/v2/operations/update-imodel-user-permissions/description.md new file mode 100644 index 0000000..af54b94 --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-user-permissions/description.md @@ -0,0 +1,27 @@ +--- + +Configures RBAC user permissions for the individual iModel. Specified permissions are assigned to the provided user. + +Individual iModel permissions allow to have more granular permissions than assigned at iTwin level. This either broadens or shrinks the set of permission the user has at iTwin level. That is, once at least one user permission is configured on the given iModel, then this configuration takes precedence over permissions configured at iTwin level. + +Role and User permissions are mutually exclusive and cannot be configured for an iModel at the same time. + +Please refer to [Access Control API](https://developer.bentley.com/apis/access-control-v2/overview/) to learn more about Role Based Access Control principles in general. + +iModel permissions that could be assigned to the provided user: + +`imodels_webview` - allows to view iModel in web browser, but does not allow to get its local copy and view in desktop app. + +`imodels_read` - allows to open and view an iModel only in read-only state. + +`imodels_write` - allows to make changes to an iModel. Allows to create and modify named versions. Allows to create mapping between PW connection and iModel to facilitate bridges. + +`imodels_manage` - allows to manage locks, codes or local copies for the entire iModel. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/imodels/v2/operations/update-imodel-user-permissions/displayName.md b/services/imodels/v2/operations/update-imodel-user-permissions/displayName.md new file mode 100644 index 0000000..d42288a --- /dev/null +++ b/services/imodels/v2/operations/update-imodel-user-permissions/displayName.md @@ -0,0 +1 @@ +Update iModel User Permissions \ No newline at end of file diff --git a/services/imodels/v2/operations/update-imodel/description.md b/services/imodels/v2/operations/update-imodel/description.md new file mode 100644 index 0000000..1d48ecc --- /dev/null +++ b/services/imodels/v2/operations/update-imodel/description.md @@ -0,0 +1,11 @@ +--- + +Update metadata of the [iModel](https://www.itwinjs.org/learning/glossary/#imodel). + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/update-imodel/displayName.md b/services/imodels/v2/operations/update-imodel/displayName.md new file mode 100644 index 0000000..434d3cc --- /dev/null +++ b/services/imodels/v2/operations/update-imodel/displayName.md @@ -0,0 +1 @@ +Update iModel \ No newline at end of file diff --git a/services/imodels/v2/operations/upload-imodel-thumbnail/description.md b/services/imodels/v2/operations/upload-imodel-thumbnail/description.md new file mode 100644 index 0000000..6fab597 --- /dev/null +++ b/services/imodels/v2/operations/upload-imodel-thumbnail/description.md @@ -0,0 +1,11 @@ +--- + +Uploads a Thumbnail file. Request content should be binary content of an image. Supported Thumbnail types are 'image/png' or 'image/jpeg', but once uploaded 'image/jpeg' will be converted to 'image/png'. Maximum supported Thumbnail size is 5 megabytes. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/imodels/v2/operations/upload-imodel-thumbnail/displayName.md b/services/imodels/v2/operations/upload-imodel-thumbnail/displayName.md new file mode 100644 index 0000000..cb5649d --- /dev/null +++ b/services/imodels/v2/operations/upload-imodel-thumbnail/displayName.md @@ -0,0 +1 @@ +Upload iModel Thumbnail \ No newline at end of file diff --git a/services/issues/v1/description.md b/services/issues/v1/description.md new file mode 100644 index 0000000..4612222 --- /dev/null +++ b/services/issues/v1/description.md @@ -0,0 +1,9 @@ +Issue Service + +View, create, and edit details of issues that have been raised in an iTwin or project, as well as their comments, attached files, and change history. Retrieval of form definitions (which define how to display an issue in an interactive UI) is also supported, though customization of them is not, and should be done by a project administrator through the CONNECT Issues web application, if needed. This form-editing app can be found at https://connect-formmanager.bentley.com/designer/#/your-itwin-id where `your-itwin-id` is replaced by the ID of the iTwin or project you're creating custom forms for. + +## Limits + +All API calls that return a list of results will return a maximum of 50 results. Some endpoints support a `$top` parameter to specify a number of results to retrieve (up to the maximum) and a `continuationToken` parameter to continue paging through results, allowing access to results beyond the first 50. These parameters will be included in the documentation for those endpoints. + +Clients with a Developer, Partner, or Integrator subscription will be limited to 5000 requests per minute. Clients with a Trial subscription will be limited to 500 requests per minute. \ No newline at end of file diff --git a/services/issues/v1/operations/add-attachment-to-issue/description.md b/services/issues/v1/operations/add-attachment-to-issue/description.md new file mode 100644 index 0000000..0b26f04 --- /dev/null +++ b/services/issues/v1/operations/add-attachment-to-issue/description.md @@ -0,0 +1,11 @@ +--- + +Adds a new attachment to the specified issue. This only creates the attachment metadata; the file will need to be uploaded through a subsequent PUT call to the URL returned in the Location header of this endpoint's response. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/add-attachment-to-issue/displayName.md b/services/issues/v1/operations/add-attachment-to-issue/displayName.md new file mode 100644 index 0000000..19f9bd6 --- /dev/null +++ b/services/issues/v1/operations/add-attachment-to-issue/displayName.md @@ -0,0 +1 @@ +Add attachment to issue \ No newline at end of file diff --git a/services/issues/v1/operations/add-comment-to-issue/description.md b/services/issues/v1/operations/add-comment-to-issue/description.md new file mode 100644 index 0000000..879189c --- /dev/null +++ b/services/issues/v1/operations/add-comment-to-issue/description.md @@ -0,0 +1,11 @@ +--- + +Adds a new comment to the specified issue. Only the comment text is needed; the author and creation time will be automatically set by the server. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/add-comment-to-issue/displayName.md b/services/issues/v1/operations/add-comment-to-issue/displayName.md new file mode 100644 index 0000000..bac0889 --- /dev/null +++ b/services/issues/v1/operations/add-comment-to-issue/displayName.md @@ -0,0 +1 @@ +Add comment to issue \ No newline at end of file diff --git a/services/issues/v1/operations/create-issue/description.md b/services/issues/v1/operations/create-issue/description.md new file mode 100644 index 0000000..824abe0 --- /dev/null +++ b/services/issues/v1/operations/create-issue/description.md @@ -0,0 +1,11 @@ +--- + +Creates a new issue. The user must specify the ID of a form definition to associate the issue with; that will set its issue type as well as determine how clients such as the CONNECT Issues web app will display it. The form definition ID should be obtained by calling the 'Get iTwin form definitions' endpoint. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Create/Modify** (`Forms_CreateAccess`) permission for the iTwin, or for the chosen form definition if form definition security is specified for it. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/create-issue/displayName.md b/services/issues/v1/operations/create-issue/displayName.md new file mode 100644 index 0000000..cbacdd5 --- /dev/null +++ b/services/issues/v1/operations/create-issue/displayName.md @@ -0,0 +1 @@ +Create issue \ No newline at end of file diff --git a/services/issues/v1/operations/delete-attachment/description.md b/services/issues/v1/operations/delete-attachment/description.md new file mode 100644 index 0000000..d717d36 --- /dev/null +++ b/services/issues/v1/operations/delete-attachment/description.md @@ -0,0 +1,11 @@ +--- + +Deletes the specified attachment (including both its metadata and file) from the specified issue. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/delete-attachment/displayName.md b/services/issues/v1/operations/delete-attachment/displayName.md new file mode 100644 index 0000000..b879ec7 --- /dev/null +++ b/services/issues/v1/operations/delete-attachment/displayName.md @@ -0,0 +1 @@ +Delete attachment \ No newline at end of file diff --git a/services/issues/v1/operations/delete-comment/description.md b/services/issues/v1/operations/delete-comment/description.md new file mode 100644 index 0000000..1609387 --- /dev/null +++ b/services/issues/v1/operations/delete-comment/description.md @@ -0,0 +1,11 @@ +--- + +Deletes the specified comment from the specified issue. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/delete-comment/displayName.md b/services/issues/v1/operations/delete-comment/displayName.md new file mode 100644 index 0000000..f8af28e --- /dev/null +++ b/services/issues/v1/operations/delete-comment/displayName.md @@ -0,0 +1 @@ +Delete comment \ No newline at end of file diff --git a/services/issues/v1/operations/delete-issue/description.md b/services/issues/v1/operations/delete-issue/description.md new file mode 100644 index 0000000..7e7eff6 --- /dev/null +++ b/services/issues/v1/operations/delete-issue/description.md @@ -0,0 +1,11 @@ +--- + +Deletes the issue with the specified ID. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Delete** (`Forms_DeleteForms`) permission for the iTwin. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/delete-issue/displayName.md b/services/issues/v1/operations/delete-issue/displayName.md new file mode 100644 index 0000000..a395811 --- /dev/null +++ b/services/issues/v1/operations/delete-issue/displayName.md @@ -0,0 +1 @@ +Delete issue \ No newline at end of file diff --git a/services/issues/v1/operations/download-issue-as-file/description.md b/services/issues/v1/operations/download-issue-as-file/description.md new file mode 100644 index 0000000..aaaf009 --- /dev/null +++ b/services/issues/v1/operations/download-issue-as-file/description.md @@ -0,0 +1,9 @@ +--- + +Gets the specified issue exported to the specified file format. Currently, the default--and only supported format--is PDF. The issue with the specified ID will be laid out in the PDF according to its associated form definition. + +The generated PDF will have a header at the top of each page with metadata about the issue (such as its name and creation date) unless the 'includeHeader' query parameter is set to false. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/download-issue-as-file/displayName.md b/services/issues/v1/operations/download-issue-as-file/displayName.md new file mode 100644 index 0000000..b8137d2 --- /dev/null +++ b/services/issues/v1/operations/download-issue-as-file/displayName.md @@ -0,0 +1 @@ +Download issue as file \ No newline at end of file diff --git a/services/issues/v1/operations/export-issues-to-storage/description.md b/services/issues/v1/operations/export-issues-to-storage/description.md new file mode 100644 index 0000000..a16c3a0 --- /dev/null +++ b/services/issues/v1/operations/export-issues-to-storage/description.md @@ -0,0 +1,13 @@ +--- + +Requests that anywhere from 1 to 5 issues be exported to a file and saved in cloud-based storage (accessible through the Storage API). Currently 'pdf' is the only supported file type. The IDs of the issues must be specified in a query string parameter named "ids", separated by commas if there is more than one. A sample request URL that exports 3 issues to a PDF is as follows-- + +https://api.bentley.com/issues/exportPdfToStorage?ids=abab23524535,89458jjlij,32636wtewtwt&folderId=090909877987&includeHeader=true + +Note that unlike most GET requests, this is not an idempotent operation; each time it is called, a new file will be generated. The response will not contain the file itself, but links to download it from Storage. + +All issues specified in the request must come from the same iTwin, or the request will fail. The client may also specify the ID of a destination folder where the file should be saved; otherwise, it will be saved in the iTwin's root folder. They can also specify whether to include a textual header with issue metadata at the top of each page (default) or exclude it. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/export-issues-to-storage/displayName.md b/services/issues/v1/operations/export-issues-to-storage/displayName.md new file mode 100644 index 0000000..57a5cd3 --- /dev/null +++ b/services/issues/v1/operations/export-issues-to-storage/displayName.md @@ -0,0 +1 @@ +Export issues to Storage \ No newline at end of file diff --git a/services/issues/v1/operations/get-attachment-by-id/description.md b/services/issues/v1/operations/get-attachment-by-id/description.md new file mode 100644 index 0000000..cb326ff --- /dev/null +++ b/services/issues/v1/operations/get-attachment-by-id/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves the actual file contents for the attachment with the given ID. This API will attempt to infer the MIME type to return from the file's extension, but will return the default value of `application/octet-stream` if it does not recognize the extension. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the issue's associated definition if form definition security is specified. (Having any other Forms permission automatically grants the **View** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/get-attachment-by-id/displayName.md b/services/issues/v1/operations/get-attachment-by-id/displayName.md new file mode 100644 index 0000000..f7ec252 --- /dev/null +++ b/services/issues/v1/operations/get-attachment-by-id/displayName.md @@ -0,0 +1 @@ +Get attachment file by ID \ No newline at end of file diff --git a/services/issues/v1/operations/get-form-definition-by-id/description.md b/services/issues/v1/operations/get-form-definition-by-id/description.md new file mode 100644 index 0000000..5f5ca5d --- /dev/null +++ b/services/issues/v1/operations/get-form-definition-by-id/description.md @@ -0,0 +1,7 @@ +--- + +Gets the full form definition with the specified ID. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/get-form-definition-by-id/displayName.md b/services/issues/v1/operations/get-form-definition-by-id/displayName.md new file mode 100644 index 0000000..da62ef6 --- /dev/null +++ b/services/issues/v1/operations/get-form-definition-by-id/displayName.md @@ -0,0 +1 @@ +Get form definition by ID \ No newline at end of file diff --git a/services/issues/v1/operations/get-issue-attachments/description.md b/services/issues/v1/operations/get-issue-attachments/description.md new file mode 100644 index 0000000..c178040 --- /dev/null +++ b/services/issues/v1/operations/get-issue-attachments/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves the metadata for all files attached to the given issue. In order to get the contents of a file itself, use the `Get attachment file by ID` endpoint, passing the `id` from the metadata object returned by this request as the `attachmentId` parameter of that request. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having any other level of Forms permission automatically grants the **View** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/get-issue-attachments/displayName.md b/services/issues/v1/operations/get-issue-attachments/displayName.md new file mode 100644 index 0000000..91ac011 --- /dev/null +++ b/services/issues/v1/operations/get-issue-attachments/displayName.md @@ -0,0 +1 @@ +Get issue attachments \ No newline at end of file diff --git a/services/issues/v1/operations/get-issue-audit-trail/description.md b/services/issues/v1/operations/get-issue-audit-trail/description.md new file mode 100644 index 0000000..a6fd53c --- /dev/null +++ b/services/issues/v1/operations/get-issue-audit-trail/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves a reverse-chronologically-ordered list of all changes that have been made to this issue, including authors, dates, and old vs. new property values. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the issue's associated definition if form definition security is specified. (Having any other level of Forms permission automatically grants the **View** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/get-issue-audit-trail/displayName.md b/services/issues/v1/operations/get-issue-audit-trail/displayName.md new file mode 100644 index 0000000..1697d44 --- /dev/null +++ b/services/issues/v1/operations/get-issue-audit-trail/displayName.md @@ -0,0 +1 @@ +Get issue audit trail \ No newline at end of file diff --git a/services/issues/v1/operations/get-issue-comments/description.md b/services/issues/v1/operations/get-issue-comments/description.md new file mode 100644 index 0000000..45eb802 --- /dev/null +++ b/services/issues/v1/operations/get-issue-comments/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves the text and metadata for all comments that have been posted to the given issue. If the Prefer header was specified with the value "return=representation", the response will include the email address of each comment author, though this may incur additional processing time. If there is an extraordinarily large number of comments, only 50 distinct user email addresses will be retrieved and shown. Regardless of the Prefer header value, the "_links" object associated with each comment will provide a link to additional information about the comment author. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having any other level of Forms permission automatically grants the **View** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/get-issue-comments/displayName.md b/services/issues/v1/operations/get-issue-comments/displayName.md new file mode 100644 index 0000000..86d46d8 --- /dev/null +++ b/services/issues/v1/operations/get-issue-comments/displayName.md @@ -0,0 +1 @@ +Get issue comments \ No newline at end of file diff --git a/services/issues/v1/operations/get-issue-details/description.md b/services/issues/v1/operations/get-issue-details/description.md new file mode 100644 index 0000000..d31495f --- /dev/null +++ b/services/issues/v1/operations/get-issue-details/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves all properties of the specified issue. + +Known, common properties will be returned directly on the 'issue' object, whereas custom properties unique to the issue's type will be returned on the 'properties' sub-object. + +Note that many properties in the schema are described as 'Origin info.' This means that they are metadata about where the issue came from and what business domain object(s) it is related to, such as a PDF file or a 3D model. Their meanings can differ from application to application. Many applications will use only a subset of these properties, and in general applications SHOULD NOT use or set these values unless they have a good reason to do so. Other properties, not marked 'Origin info', will commonly be set on most issues, but clients SHOULD NOT assume that all of them are set. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having any other level of Forms permission automatically grants the **View** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/get-issue-details/displayName.md b/services/issues/v1/operations/get-issue-details/displayName.md new file mode 100644 index 0000000..dbb8e05 --- /dev/null +++ b/services/issues/v1/operations/get-issue-details/displayName.md @@ -0,0 +1 @@ +Get issue details \ No newline at end of file diff --git a/services/issues/v1/operations/get-list-group/description.md b/services/issues/v1/operations/get-list-group/description.md new file mode 100644 index 0000000..121f740 --- /dev/null +++ b/services/issues/v1/operations/get-list-group/description.md @@ -0,0 +1,11 @@ +--- + +Use this request to look up a list group, which is a nested object structure that defines the options available in a chain of cascading list form controls. (Cascading lists are a set of <select> elements where only the first one is initially enabled until an option in it is selected, and then, depending on which option was selected, the available options in the next list can vary.) Each property in the structure represents an option in a select list, and its children represent options that become available in the next list in the chain if that option is selected. + +### Sample Explanation + +The sample for the 200 response shows an example of a list group that could be assigned to 3 controls in a form to let the user pick an American football team by conference, division, and name. Since the result has two properties ("AFC" and "NFC") as direct children of the "optionsTree" property, the first list in the cascading list chain would have two options--"AFC" and "NFC". Whichever option is chosen, its child properties become available for selection in the second list, and so forth. For example, if "AFC" and "North" were chosen for the first two lists respectively, the third list would show the available options "Bengals", "Browns", "Ravens", and "Steelers". These four properties just have empty objects as their values because this particular list group only has three layers; these options are the final options in the chain and have no descendants. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/get-list-group/displayName.md b/services/issues/v1/operations/get-list-group/displayName.md new file mode 100644 index 0000000..1021dc9 --- /dev/null +++ b/services/issues/v1/operations/get-list-group/displayName.md @@ -0,0 +1 @@ +Get list group \ No newline at end of file diff --git a/services/issues/v1/operations/get-project-form-definitions/description.md b/services/issues/v1/operations/get-project-form-definitions/description.md new file mode 100644 index 0000000..5e7339a --- /dev/null +++ b/services/issues/v1/operations/get-project-form-definitions/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves a list of Approved form definitions for the project with the given ID. This only returns the definition's name, type, and ID. The full definitions will be returned in the 'Get form definition by ID' endpoint. + +Note that in order to create an issue, it must be associated with the ID of one of these form definitions (through the 'formId' property in the 'Create issue' request body). This API cannot be used to create or edit form definitions. They can only be created/edited/imported by project administrators through the Bentley Form Manager webapp, which is accessible at https://connect-formmanager.bentley.com/designer/#/your-itwin-id (replace `your-itwin-id` with your actual project or iTwin ID). + +Note that the 'iTwinId' query string parameter is required. It must be a valid iTwin or project GUID to get form definitions from. Older clients can continue to use 'projectId' as an alias for 'iTwinId'. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/get-project-form-definitions/displayName.md b/services/issues/v1/operations/get-project-form-definitions/displayName.md new file mode 100644 index 0000000..f8f3335 --- /dev/null +++ b/services/issues/v1/operations/get-project-form-definitions/displayName.md @@ -0,0 +1 @@ +Get iTwin form definitions \ No newline at end of file diff --git a/services/issues/v1/operations/get-project-issues/description.md b/services/issues/v1/operations/get-project-issues/description.md new file mode 100644 index 0000000..b2a03fd --- /dev/null +++ b/services/issues/v1/operations/get-project-issues/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves a list of issues for the iTwin or project with the given ID. If the Prefer header is omitted, or set to "return=minimal", this only returns basic info about each issue--its ID, display name, type, subject, and whether it is in an Open, Closed, or Draft state. Setting the Prefer header to "return=representation" will return more data. Use the "Get Issue Details" endpoint to see full information about a particular issue. + +Note that the 'iTwinId' query string parameter is required. It must be a valid project GUID to get issues from. Existing clients can continue to use the 'projectId' paramater as an alias for 'iTwinId'. + +### Permissions + +To use this endpoint, the user is required to have the Forms **View** permission (`Forms_ViewAccess`) for the iTwin, or for some issues' associated form definitions if form definition security is specified. (Having any other level of Forms permission for an issue automatically grants the **View** permission as well for that issue. If a user does not have permission to view a particular issue, it will be silently excluded from the list.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/get-project-issues/displayName.md b/services/issues/v1/operations/get-project-issues/displayName.md new file mode 100644 index 0000000..323ba3f --- /dev/null +++ b/services/issues/v1/operations/get-project-issues/displayName.md @@ -0,0 +1 @@ +Get iTwin issues \ No newline at end of file diff --git a/services/issues/v1/operations/get-static-image/description.md b/services/issues/v1/operations/get-static-image/description.md new file mode 100644 index 0000000..769abef --- /dev/null +++ b/services/issues/v1/operations/get-static-image/description.md @@ -0,0 +1,7 @@ +--- + +Gets a link to a static image to be displayed in a form. The 'fileId' parameter should match the 'fileId' property of a static image control in the form definition. It will be a positive integer. This endpoint returns only a _links object containing the URL of the actual file, which will be publicly available at that URL for a brief time and can be set as the 'src' attribute of an HTML tag to display the image. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/get-static-image/displayName.md b/services/issues/v1/operations/get-static-image/displayName.md new file mode 100644 index 0000000..cc47498 --- /dev/null +++ b/services/issues/v1/operations/get-static-image/displayName.md @@ -0,0 +1 @@ +Get static image \ No newline at end of file diff --git a/services/issues/v1/operations/get-workflow/description.md b/services/issues/v1/operations/get-workflow/description.md new file mode 100644 index 0000000..6c32ea6 --- /dev/null +++ b/services/issues/v1/operations/get-workflow/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves the workflow for the given issue type in the given iTwin or project. The iTwin must be specified using the 'iTwinId' query string parameter. Existing clients can continue to use the 'projectId' parameter as an alias for 'iTwinId'. + +It is possible for users of an iTwin to choose not to set a workflow for a given type. In that case, requests to get the workflow of that type will return a 404 Not Found response where the 'code' property of the body's 'error' object is set to "WorkflowNotFound". This does not indicate client or server error. Other HTTP status codes, or other values of the 'code' property, do indicate an unexpected error of some sort. + +Note that workflows cannot be customized through this API; they can only be added, deleted, or changed manually by project administrators through the Bentley Form Manager webapp, found at https://connect-formmanager.bentley.com/designer/#/your-itwin-id (replace `your-itwin-id` with your actual project or iTwin ID). + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/get-workflow/displayName.md b/services/issues/v1/operations/get-workflow/displayName.md new file mode 100644 index 0000000..2ac3eaf --- /dev/null +++ b/services/issues/v1/operations/get-workflow/displayName.md @@ -0,0 +1 @@ +Get workflow \ No newline at end of file diff --git a/services/issues/v1/operations/modify-issue/description.md b/services/issues/v1/operations/modify-issue/description.md new file mode 100644 index 0000000..96a0353 --- /dev/null +++ b/services/issues/v1/operations/modify-issue/description.md @@ -0,0 +1,19 @@ +--- + +Modifies the provided properties of the specified issue to match the values provided in the request. + +Setting a property value to null in the request will set the corresponding property value to null on the issue. However, omitting a property from the request body entirely will leave that property's current value on the issue unchanged. Also, setting an object (other than "properties") to null will have the same effect as setting each individual property in that object to null. + +### Permissions + +To use this endpoint, the user is required to have different Forms permission levels (for the iTwin, or for the issue's associated form definition if form definition security is specified) based on the changes being made: + +- Change to the `status` property: **Approve** (`Forms_ApproveAccess`) permission +- Change to the `assignee` or `assignees` property: **Assign** (`Forms_AssignAccess`) or **Approve** permission +- Changes to other properties: **Create/Modify** (`Forms_CreateAccess`) permission + +**Full Access** (`Forms_FullAccess`) will satisfy all of these requirements. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/modify-issue/displayName.md b/services/issues/v1/operations/modify-issue/displayName.md new file mode 100644 index 0000000..79fe2bb --- /dev/null +++ b/services/issues/v1/operations/modify-issue/displayName.md @@ -0,0 +1 @@ +Update issue \ No newline at end of file diff --git a/services/issues/v1/operations/upload-attachment-file/description.md b/services/issues/v1/operations/upload-attachment-file/description.md new file mode 100644 index 0000000..bd05da6 --- /dev/null +++ b/services/issues/v1/operations/upload-attachment-file/description.md @@ -0,0 +1,11 @@ +--- + +Uploads a file's contents, associating it with the attachment metadata instance with the given ID. The request body is simply the file's bytes. If a file was already uploaded for the attachment with the given ID, that file will be overwritten. + +### Permissions + +To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/issues/v1/operations/upload-attachment-file/displayName.md b/services/issues/v1/operations/upload-attachment-file/displayName.md new file mode 100644 index 0000000..aefe0db --- /dev/null +++ b/services/issues/v1/operations/upload-attachment-file/displayName.md @@ -0,0 +1 @@ +Upload attachment file \ No newline at end of file diff --git a/services/itwin-entities/v1/description.md b/services/itwin-entities/v1/description.md new file mode 100644 index 0000000..b222a4a --- /dev/null +++ b/services/itwin-entities/v1/description.md @@ -0,0 +1 @@ +The iTwin Entities Service manages an index of the content repositories of an iTwin. A separate Entity Index is created for each iTwin. The entity index contains Entities for the iTwin. The entities maintian Links to detailed records about the entity in the content repositories. \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/create-entity/description.md b/services/itwin-entities/v1/operations/create-entity/description.md new file mode 100644 index 0000000..4637763 --- /dev/null +++ b/services/itwin-entities/v1/operations/create-entity/description.md @@ -0,0 +1,9 @@ +--- + +Create a new iTwin Entity + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/create-entity/displayName.md b/services/itwin-entities/v1/operations/create-entity/displayName.md new file mode 100644 index 0000000..af6a7b6 --- /dev/null +++ b/services/itwin-entities/v1/operations/create-entity/displayName.md @@ -0,0 +1 @@ +Create Entity \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/create-hierarchy-nodes/description.md b/services/itwin-entities/v1/operations/create-hierarchy-nodes/description.md new file mode 100644 index 0000000..be2932b --- /dev/null +++ b/services/itwin-entities/v1/operations/create-hierarchy-nodes/description.md @@ -0,0 +1,9 @@ +--- + +Create a new HierarchyNode for an entity. If a guid for the NodeId is not provided, a new GUID for nodeId will be assigned for each entity. Do not specify a parentId to create a root level node. The children list can be populated for any child nodes to be created under this HierarchyNode at the same time. A new nodeId can optionally be autamtically generated for the child nodes if the NodeId is not provided. The parentId for the child nodes also does not need to be specified and will be automatically populated. The children list can be a resursive, multi-level list. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/create-hierarchy-nodes/displayName.md b/services/itwin-entities/v1/operations/create-hierarchy-nodes/displayName.md new file mode 100644 index 0000000..cab9812 --- /dev/null +++ b/services/itwin-entities/v1/operations/create-hierarchy-nodes/displayName.md @@ -0,0 +1 @@ +Create Hierarchy Nodes \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/create-hierarchy/description.md b/services/itwin-entities/v1/operations/create-hierarchy/description.md new file mode 100644 index 0000000..037c7b5 --- /dev/null +++ b/services/itwin-entities/v1/operations/create-hierarchy/description.md @@ -0,0 +1,9 @@ +--- + +Create a new Hierarchy. It desribes a hierarchy or 'breakdown' for organizing entities for an iTwin. There can be multiple hierarchies for representing different breakdowns for the same iTwin. Each Hierarchy has a unique name. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/create-hierarchy/displayName.md b/services/itwin-entities/v1/operations/create-hierarchy/displayName.md new file mode 100644 index 0000000..81cf3dc --- /dev/null +++ b/services/itwin-entities/v1/operations/create-hierarchy/displayName.md @@ -0,0 +1 @@ +Create Hierarchy \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/create-link/description.md b/services/itwin-entities/v1/operations/create-link/description.md new file mode 100644 index 0000000..26c4376 --- /dev/null +++ b/services/itwin-entities/v1/operations/create-link/description.md @@ -0,0 +1,9 @@ +--- + +Create a new Link for an iTwin Entity + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/create-link/displayName.md b/services/itwin-entities/v1/operations/create-link/displayName.md new file mode 100644 index 0000000..fec26a4 --- /dev/null +++ b/services/itwin-entities/v1/operations/create-link/displayName.md @@ -0,0 +1 @@ +Create Link \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/delete-entity/description.md b/services/itwin-entities/v1/operations/delete-entity/description.md new file mode 100644 index 0000000..4aa68c0 --- /dev/null +++ b/services/itwin-entities/v1/operations/delete-entity/description.md @@ -0,0 +1,9 @@ +--- + +Delete the specified iTwin Entity. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/delete-entity/displayName.md b/services/itwin-entities/v1/operations/delete-entity/displayName.md new file mode 100644 index 0000000..f36a5fc --- /dev/null +++ b/services/itwin-entities/v1/operations/delete-entity/displayName.md @@ -0,0 +1 @@ +Delete Entity \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/delete-hierarchy-node/description.md b/services/itwin-entities/v1/operations/delete-hierarchy-node/description.md new file mode 100644 index 0000000..2b755b0 --- /dev/null +++ b/services/itwin-entities/v1/operations/delete-hierarchy-node/description.md @@ -0,0 +1,9 @@ +--- + +Delete the specified Hierarchy Node. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/delete-hierarchy-node/displayName.md b/services/itwin-entities/v1/operations/delete-hierarchy-node/displayName.md new file mode 100644 index 0000000..b1716e1 --- /dev/null +++ b/services/itwin-entities/v1/operations/delete-hierarchy-node/displayName.md @@ -0,0 +1 @@ +Delete Hierarchy Node \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/delete-hierarchy/description.md b/services/itwin-entities/v1/operations/delete-hierarchy/description.md new file mode 100644 index 0000000..bff18b9 --- /dev/null +++ b/services/itwin-entities/v1/operations/delete-hierarchy/description.md @@ -0,0 +1,9 @@ +--- + +Delete the specified Hierarchy. To delete a hierarchy, all the child hierarchy nodes must first be deleted. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/delete-hierarchy/displayName.md b/services/itwin-entities/v1/operations/delete-hierarchy/displayName.md new file mode 100644 index 0000000..da4c79c --- /dev/null +++ b/services/itwin-entities/v1/operations/delete-hierarchy/displayName.md @@ -0,0 +1 @@ +Delete Hierarchy \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/delete-link/description.md b/services/itwin-entities/v1/operations/delete-link/description.md new file mode 100644 index 0000000..e979dbd --- /dev/null +++ b/services/itwin-entities/v1/operations/delete-link/description.md @@ -0,0 +1,9 @@ +--- + +Delete the specified Link for an iTwin Entity. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/delete-link/displayName.md b/services/itwin-entities/v1/operations/delete-link/displayName.md new file mode 100644 index 0000000..760d817 --- /dev/null +++ b/services/itwin-entities/v1/operations/delete-link/displayName.md @@ -0,0 +1 @@ +Delete Link \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/get-entities/description.md b/services/itwin-entities/v1/operations/get-entities/description.md new file mode 100644 index 0000000..de6c4d4 --- /dev/null +++ b/services/itwin-entities/v1/operations/get-entities/description.md @@ -0,0 +1,9 @@ +--- + +Gets the details of the specified Entity with an iTwin. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/get-entities/displayName.md b/services/itwin-entities/v1/operations/get-entities/displayName.md new file mode 100644 index 0000000..64d378e --- /dev/null +++ b/services/itwin-entities/v1/operations/get-entities/displayName.md @@ -0,0 +1 @@ +Get Entities \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/get-entity/description.md b/services/itwin-entities/v1/operations/get-entity/description.md new file mode 100644 index 0000000..de6c4d4 --- /dev/null +++ b/services/itwin-entities/v1/operations/get-entity/description.md @@ -0,0 +1,9 @@ +--- + +Gets the details of the specified Entity with an iTwin. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/get-entity/displayName.md b/services/itwin-entities/v1/operations/get-entity/displayName.md new file mode 100644 index 0000000..fc368b6 --- /dev/null +++ b/services/itwin-entities/v1/operations/get-entity/displayName.md @@ -0,0 +1 @@ +Get Entity \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/get-hierarchies/description.md b/services/itwin-entities/v1/operations/get-hierarchies/description.md new file mode 100644 index 0000000..76a2881 --- /dev/null +++ b/services/itwin-entities/v1/operations/get-hierarchies/description.md @@ -0,0 +1,9 @@ +--- + +Gets the details of the Hierarchies for an iTwin. You can optionally query just by the name + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/get-hierarchies/displayName.md b/services/itwin-entities/v1/operations/get-hierarchies/displayName.md new file mode 100644 index 0000000..997926a --- /dev/null +++ b/services/itwin-entities/v1/operations/get-hierarchies/displayName.md @@ -0,0 +1 @@ +Get Hierarchies \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/get-hierarchy-nodes/description.md b/services/itwin-entities/v1/operations/get-hierarchy-nodes/description.md new file mode 100644 index 0000000..76a2881 --- /dev/null +++ b/services/itwin-entities/v1/operations/get-hierarchy-nodes/description.md @@ -0,0 +1,9 @@ +--- + +Gets the details of the Hierarchies for an iTwin. You can optionally query just by the name + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/get-hierarchy-nodes/displayName.md b/services/itwin-entities/v1/operations/get-hierarchy-nodes/displayName.md new file mode 100644 index 0000000..d3d99e8 --- /dev/null +++ b/services/itwin-entities/v1/operations/get-hierarchy-nodes/displayName.md @@ -0,0 +1 @@ +Get Hierarchy Nodes \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/get-hierarchy/description.md b/services/itwin-entities/v1/operations/get-hierarchy/description.md new file mode 100644 index 0000000..e4e0db1 --- /dev/null +++ b/services/itwin-entities/v1/operations/get-hierarchy/description.md @@ -0,0 +1,9 @@ +--- + +Gets the details of the specified Hierarchy for an iTwin. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/get-hierarchy/displayName.md b/services/itwin-entities/v1/operations/get-hierarchy/displayName.md new file mode 100644 index 0000000..466c325 --- /dev/null +++ b/services/itwin-entities/v1/operations/get-hierarchy/displayName.md @@ -0,0 +1 @@ +Get Hierarchy \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/get-links/description.md b/services/itwin-entities/v1/operations/get-links/description.md new file mode 100644 index 0000000..6ef9be2 --- /dev/null +++ b/services/itwin-entities/v1/operations/get-links/description.md @@ -0,0 +1,9 @@ +--- + +Gets the Links on the specified Entity within an iTwin. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/get-links/displayName.md b/services/itwin-entities/v1/operations/get-links/displayName.md new file mode 100644 index 0000000..39157e6 --- /dev/null +++ b/services/itwin-entities/v1/operations/get-links/displayName.md @@ -0,0 +1 @@ +Get Links \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/update-entity/description.md b/services/itwin-entities/v1/operations/update-entity/description.md new file mode 100644 index 0000000..31ec912 --- /dev/null +++ b/services/itwin-entities/v1/operations/update-entity/description.md @@ -0,0 +1,9 @@ +--- + +Update the specified iTwin Entity. The request payload only needs to contain the properties that you would like to update. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/update-entity/displayName.md b/services/itwin-entities/v1/operations/update-entity/displayName.md new file mode 100644 index 0000000..ac647f9 --- /dev/null +++ b/services/itwin-entities/v1/operations/update-entity/displayName.md @@ -0,0 +1 @@ +Update Entity \ No newline at end of file diff --git a/services/itwin-entities/v1/operations/update-hierarchy/description.md b/services/itwin-entities/v1/operations/update-hierarchy/description.md new file mode 100644 index 0000000..31ec912 --- /dev/null +++ b/services/itwin-entities/v1/operations/update-hierarchy/description.md @@ -0,0 +1,9 @@ +--- + +Update the specified iTwin Entity. The request payload only needs to contain the properties that you would like to update. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/itwin-entities/v1/operations/update-hierarchy/displayName.md b/services/itwin-entities/v1/operations/update-hierarchy/displayName.md new file mode 100644 index 0000000..d80a479 --- /dev/null +++ b/services/itwin-entities/v1/operations/update-hierarchy/displayName.md @@ -0,0 +1 @@ +Update Hierarchy \ No newline at end of file diff --git a/services/itwin-search/v1/description.md b/services/itwin-search/v1/description.md new file mode 100644 index 0000000..5bdbef9 --- /dev/null +++ b/services/itwin-search/v1/description.md @@ -0,0 +1 @@ +Search for resources in the context of your iTwins. iTwin Search is a one-stop endpoint for search across all searchable iTwin data. \ No newline at end of file diff --git a/services/itwin-search/v1/operations/discover/description.md b/services/itwin-search/v1/operations/discover/description.md new file mode 100644 index 0000000..12f20a9 --- /dev/null +++ b/services/itwin-search/v1/operations/discover/description.md @@ -0,0 +1,9 @@ +--- + +Gets available search providers with their supported data types. + +{!Authorization.md!} + +{!RateLimits.md!} + +--- diff --git a/services/itwin-search/v1/operations/discover/displayName.md b/services/itwin-search/v1/operations/discover/displayName.md new file mode 100644 index 0000000..21e2f9e --- /dev/null +++ b/services/itwin-search/v1/operations/discover/displayName.md @@ -0,0 +1 @@ +Discover \ No newline at end of file diff --git a/services/itwin-search/v1/operations/post-search/description.md b/services/itwin-search/v1/operations/post-search/description.md new file mode 100644 index 0000000..8ad5692 --- /dev/null +++ b/services/itwin-search/v1/operations/post-search/description.md @@ -0,0 +1,9 @@ +--- + +Search for resources in the context of your iTwins. iTwin Search is a one-stop endpoint for search across all searchable iTwin data. + +{!Authorization.md!} + +{!RateLimits.md!} + +--- diff --git a/services/itwin-search/v1/operations/post-search/displayName.md b/services/itwin-search/v1/operations/post-search/displayName.md new file mode 100644 index 0000000..7356d9c --- /dev/null +++ b/services/itwin-search/v1/operations/post-search/displayName.md @@ -0,0 +1 @@ +Search \ No newline at end of file diff --git a/services/itwins/v1/description.md b/services/itwins/v1/description.md new file mode 100644 index 0000000..3bb4a63 --- /dev/null +++ b/services/itwins/v1/description.md @@ -0,0 +1 @@ +Interact with your iTwins. \ No newline at end of file diff --git a/services/itwins/v1/operations/add-itwin-to-my-favorites/description.md b/services/itwins/v1/operations/add-itwin-to-my-favorites/description.md new file mode 100644 index 0000000..256079d --- /dev/null +++ b/services/itwins/v1/operations/add-itwin-to-my-favorites/description.md @@ -0,0 +1,9 @@ +--- + +Add an iTwin to the calling user's favorites list. + +{!Authorization.md!} + +{!iTwinMemberOfAuthorization.md!} + +--- diff --git a/services/itwins/v1/operations/add-itwin-to-my-favorites/displayName.md b/services/itwins/v1/operations/add-itwin-to-my-favorites/displayName.md new file mode 100644 index 0000000..dd0cca2 --- /dev/null +++ b/services/itwins/v1/operations/add-itwin-to-my-favorites/displayName.md @@ -0,0 +1 @@ +Add iTwin to my favorites \ No newline at end of file diff --git a/services/itwins/v1/operations/add-itwin-to-my-recents/description.md b/services/itwins/v1/operations/add-itwin-to-my-recents/description.md new file mode 100644 index 0000000..7a7cab9 --- /dev/null +++ b/services/itwins/v1/operations/add-itwin-to-my-recents/description.md @@ -0,0 +1,9 @@ +--- + +Adds an iTwin to the calling User's recently used iTwins list. No more than 25 iTwins are stored in the recently used list. Older ones are removed to make room for new ones. + +{!Authorization.md!} + +{!iTwinMemberOfAuthorization.md!} + +--- \ No newline at end of file diff --git a/services/itwins/v1/operations/add-itwin-to-my-recents/displayName.md b/services/itwins/v1/operations/add-itwin-to-my-recents/displayName.md new file mode 100644 index 0000000..106c684 --- /dev/null +++ b/services/itwins/v1/operations/add-itwin-to-my-recents/displayName.md @@ -0,0 +1 @@ +Add iTwin to my recents \ No newline at end of file diff --git a/services/itwins/v1/operations/create-itwin/description.md b/services/itwins/v1/operations/create-itwin/description.md new file mode 100644 index 0000000..cff93dc --- /dev/null +++ b/services/itwins/v1/operations/create-itwin/description.md @@ -0,0 +1,16 @@ +--- + +Create a new iTwin. + +The user that creates the iTwin will automatically be given the `iTwin owner` role on the iTwin. This will give that user full access to the iTwin, including the ability to create new child iTwins under the iTwin they are creating. After the iTwin is created, the `iTwin owner` role can be removed from the user or granted to other users. + +{!Authorization.md!} + +### Authorization +The user must have the `itwins_create` permission on the parent iTwin specified in the request. If there is no parent iTwin in the request then the user must have the `itwins_create` permission on the [Account iTwin] (https://developer.bentley.com/apis/iTwins/overview/#account). + +An Organization Administrator can create iTwins for their Organization. + +{!iTwinAdminOnlyAuthorization.md!} + +--- diff --git a/services/itwins/v1/operations/create-itwin/displayName.md b/services/itwins/v1/operations/create-itwin/displayName.md new file mode 100644 index 0000000..42a988b --- /dev/null +++ b/services/itwins/v1/operations/create-itwin/displayName.md @@ -0,0 +1 @@ +Create iTwin \ No newline at end of file diff --git a/services/itwins/v1/operations/create-repository/description.md b/services/itwins/v1/operations/create-repository/description.md new file mode 100644 index 0000000..103cf95 --- /dev/null +++ b/services/itwins/v1/operations/create-repository/description.md @@ -0,0 +1,26 @@ +--- + +Creates a new Repository URI. + +A repository is a Uri link to iTwin data managed by another service. The links for most classes are autogenerated but some can only be added manually using this POST endpoint. + +The following Classes/SubClasses can be added using this POST endpoint. +- GeographicInformationSystem + + WebMapService + + WebMapTileService + + MapServer +- Construction + + Performance +- Subsurface + + EvoWorkspace + +{!Authorization.md!} + +### Authorization +The user must have the `itwins_modify` permission in order to add a repository URI to the iTwin. + +An Organization Administrator can modify iTwins owned by their Organization. This includes adding a repository URI. + +{!iTwinAdminOnlyAuthorization.md!} + +--- diff --git a/services/itwins/v1/operations/create-repository/displayName.md b/services/itwins/v1/operations/create-repository/displayName.md new file mode 100644 index 0000000..d9c3c98 --- /dev/null +++ b/services/itwins/v1/operations/create-repository/displayName.md @@ -0,0 +1 @@ +Create iTwin repository \ No newline at end of file diff --git a/services/itwins/v1/operations/delete-itwin-image/description.md b/services/itwins/v1/operations/delete-itwin-image/description.md new file mode 100644 index 0000000..dc1d706 --- /dev/null +++ b/services/itwins/v1/operations/delete-itwin-image/description.md @@ -0,0 +1,14 @@ +--- + +Deletes the image assoicated with the specified iTwin. + +{!Authorization.md!} + +### Authorization +The user must have the `itwins_modify` permission on the iTwin in order to delete the image associated with the iTwin. + +An Organization Administrator can modify any iTwins owned by their Organization. This allows Organization Administrators to delete the iTwin image. + +{!iTwinAdminOnlyAuthorization.md!} + +--- \ No newline at end of file diff --git a/services/itwins/v1/operations/delete-itwin-image/displayName.md b/services/itwins/v1/operations/delete-itwin-image/displayName.md new file mode 100644 index 0000000..dd28bef --- /dev/null +++ b/services/itwins/v1/operations/delete-itwin-image/displayName.md @@ -0,0 +1 @@ +Delete iTwin Image \ No newline at end of file diff --git a/services/itwins/v1/operations/delete-itwin/description.md b/services/itwins/v1/operations/delete-itwin/description.md new file mode 100644 index 0000000..f27d56d --- /dev/null +++ b/services/itwins/v1/operations/delete-itwin/description.md @@ -0,0 +1,12 @@ +--- + +Delete the specified iTwin. + +{!Authorization.md!} + +### Authorization +Only an Organization Administrator can delete iTwins owned by their Organization. + +{!iTwinAdminOnlyAuthorization.md!} + +--- diff --git a/services/itwins/v1/operations/delete-itwin/displayName.md b/services/itwins/v1/operations/delete-itwin/displayName.md new file mode 100644 index 0000000..34d994f --- /dev/null +++ b/services/itwins/v1/operations/delete-itwin/displayName.md @@ -0,0 +1 @@ +Delete iTwin \ No newline at end of file diff --git a/services/itwins/v1/operations/delete-repository/description.md b/services/itwins/v1/operations/delete-repository/description.md new file mode 100644 index 0000000..882cf51 --- /dev/null +++ b/services/itwins/v1/operations/delete-repository/description.md @@ -0,0 +1,16 @@ +--- + +Delete the specified Repository URI. + +Only repositories added via the POST endpoint can be deleted. Autogenerated repository Uris cannot be deleted. + +{!Authorization.md!} + +### Authorization +The user must have the `itwins_modify` permission in order to remove a repository URI from the iTwin. + +An Organization Administrator can modify iTwins owned by their Organization. This includes deleting a repository URI. + +{!iTwinAdminOnlyAuthorization.md!} + +--- diff --git a/services/itwins/v1/operations/delete-repository/displayName.md b/services/itwins/v1/operations/delete-repository/displayName.md new file mode 100644 index 0000000..eb72ed7 --- /dev/null +++ b/services/itwins/v1/operations/delete-repository/displayName.md @@ -0,0 +1 @@ +Delete iTwin repository \ No newline at end of file diff --git a/services/itwins/v1/operations/get-itwin-account/description.md b/services/itwins/v1/operations/get-itwin-account/description.md new file mode 100644 index 0000000..bd273d4 --- /dev/null +++ b/services/itwins/v1/operations/get-itwin-account/description.md @@ -0,0 +1,9 @@ +--- + +Gets the Account for the specified iTwin. + +{!Authorization.md!} + +{!iTwinMemberOfAuthorization.md!} + +--- diff --git a/services/itwins/v1/operations/get-itwin-account/displayName.md b/services/itwins/v1/operations/get-itwin-account/displayName.md new file mode 100644 index 0000000..c4401b5 --- /dev/null +++ b/services/itwins/v1/operations/get-itwin-account/displayName.md @@ -0,0 +1 @@ +Get iTwin account \ No newline at end of file diff --git a/services/itwins/v1/operations/get-itwin-image/description.md b/services/itwins/v1/operations/get-itwin-image/description.md new file mode 100644 index 0000000..b54adec --- /dev/null +++ b/services/itwins/v1/operations/get-itwin-image/description.md @@ -0,0 +1,13 @@ +--- + +Gets the image metadata for the specified iTwin. + +The metadata will contain the name of the image and a URL for downloading the image. The name of the image is unique and will only change if the image changes. It can be used as a long term cache key to determine if you have already downloaded the image. The URLs will be valid for a minimum of 1 hour. + +This API is used to get a link to the small image and the original uploaded image. To make it easier to use the small image as a thumbnail, the small image link is also included as a property on every iTwin. + +{!Authorization.md!} + +{!iTwinMemberOfAuthorization.md!} + +--- \ No newline at end of file diff --git a/services/itwins/v1/operations/get-itwin-image/displayName.md b/services/itwins/v1/operations/get-itwin-image/displayName.md new file mode 100644 index 0000000..fd41950 --- /dev/null +++ b/services/itwins/v1/operations/get-itwin-image/displayName.md @@ -0,0 +1 @@ +Get iTwin Image \ No newline at end of file diff --git a/services/itwins/v1/operations/get-itwin/description.md b/services/itwins/v1/operations/get-itwin/description.md new file mode 100644 index 0000000..7065b21 --- /dev/null +++ b/services/itwins/v1/operations/get-itwin/description.md @@ -0,0 +1,9 @@ +--- + +Gets the metadata of the specified iTwin. + +{!Authorization.md!} + +{!iTwinMemberOfAuthorization.md!} + +--- diff --git a/services/itwins/v1/operations/get-itwin/displayName.md b/services/itwins/v1/operations/get-itwin/displayName.md new file mode 100644 index 0000000..1205bc7 --- /dev/null +++ b/services/itwins/v1/operations/get-itwin/displayName.md @@ -0,0 +1 @@ +Get iTwin \ No newline at end of file diff --git a/services/itwins/v1/operations/get-my-favorite-itwins/description.md b/services/itwins/v1/operations/get-my-favorite-itwins/description.md new file mode 100644 index 0000000..e1d362d --- /dev/null +++ b/services/itwins/v1/operations/get-my-favorite-itwins/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves a list of favorite iTwins for the calling user. + +{!InactiveiTwinInfo.md!} + +{!Authorization.md!} + +{!iTwinMemberOfAuthorizationGetAll.md!} + +--- diff --git a/services/itwins/v1/operations/get-my-favorite-itwins/displayName.md b/services/itwins/v1/operations/get-my-favorite-itwins/displayName.md new file mode 100644 index 0000000..5808cbf --- /dev/null +++ b/services/itwins/v1/operations/get-my-favorite-itwins/displayName.md @@ -0,0 +1 @@ +Get my favorite iTwins \ No newline at end of file diff --git a/services/itwins/v1/operations/get-my-itwins/description.md b/services/itwins/v1/operations/get-my-itwins/description.md new file mode 100644 index 0000000..071a4cd --- /dev/null +++ b/services/itwins/v1/operations/get-my-itwins/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves a list of iTwins that the calling user is a member of. + +{!InactiveiTwinInfo.md!} + +{!Authorization.md!} + +{!iTwinMemberOfAuthorizationGetAll.md!} + +--- diff --git a/services/itwins/v1/operations/get-my-itwins/displayName.md b/services/itwins/v1/operations/get-my-itwins/displayName.md new file mode 100644 index 0000000..863eef6 --- /dev/null +++ b/services/itwins/v1/operations/get-my-itwins/displayName.md @@ -0,0 +1 @@ +Get my iTwins \ No newline at end of file diff --git a/services/itwins/v1/operations/get-my-primary-account/description.md b/services/itwins/v1/operations/get-my-primary-account/description.md new file mode 100644 index 0000000..9ae581f --- /dev/null +++ b/services/itwins/v1/operations/get-my-primary-account/description.md @@ -0,0 +1,13 @@ +--- + +Returns the primary Account for the calling user. + +When a user creates a new iTwin, it will be created in the primary Account unless specified otherwise. + +If a user is associated with an Organization, that user will be able to query for any Account iTwin owned by their Organization. If the Organization has more than one Account then the MyPrimaryAccount endpoint will return only the primary Account for that Organization. Other Accounts can be queried using the [Get My iTwins](https://developer.bentley.com/apis/itwins/operations/get-my-itwins/) endpoint with the subClass=Account parameter. + +If a user is not associated with an Organization, then a single Account iTwin will be created for the user. The MyPrimaryAccount endpoint will return that Account. + +{!Authorization.md!} + +--- diff --git a/services/itwins/v1/operations/get-my-primary-account/displayName.md b/services/itwins/v1/operations/get-my-primary-account/displayName.md new file mode 100644 index 0000000..627e3dc --- /dev/null +++ b/services/itwins/v1/operations/get-my-primary-account/displayName.md @@ -0,0 +1 @@ +Get My Primary Account \ No newline at end of file diff --git a/services/itwins/v1/operations/get-my-recently-used-itwins/description.md b/services/itwins/v1/operations/get-my-recently-used-itwins/description.md new file mode 100644 index 0000000..d49000d --- /dev/null +++ b/services/itwins/v1/operations/get-my-recently-used-itwins/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves a list of recently used iTwins for the calling user. + +{!InactiveiTwinInfo.md!} + +{!Authorization.md!} + +{!iTwinMemberOfAuthorizationGetAll.md!} + +--- diff --git a/services/itwins/v1/operations/get-my-recently-used-itwins/displayName.md b/services/itwins/v1/operations/get-my-recently-used-itwins/displayName.md new file mode 100644 index 0000000..34c804a --- /dev/null +++ b/services/itwins/v1/operations/get-my-recently-used-itwins/displayName.md @@ -0,0 +1 @@ +Get my recently used iTwins \ No newline at end of file diff --git a/services/itwins/v1/operations/get-repositories-by-itwin-id/description.md b/services/itwins/v1/operations/get-repositories-by-itwin-id/description.md new file mode 100644 index 0000000..4b224d1 --- /dev/null +++ b/services/itwins/v1/operations/get-repositories-by-itwin-id/description.md @@ -0,0 +1,48 @@ +--- + +Gets the details of the specified repository. + +A repository is a Uri link to iTwin data managed by another service. + +For example, if an iTwin has Forms data then you can get the Uri for that +data by using this api and specifying iTwinId = 547d397a-9921-4e4f-a7a2-c47fc19219b0 and Class = Forms. It will return the following. +``` +{ + "repositories": [ + { + "id": "547d397a-9921-4e4f-a7a2-c47fc19219b0", + "class": "Forms", + "subClass": null, + "uri": "https://api.bentley.com/forms?projectId=547d397a-9921-4e4f-a7a2-c47fc19219b0" + }] +} +``` +If no Class is specified then all repositories containing data for the iTwin will be returned. The Uri is automatically generated +by calling each service to determine if its repository contains data for the specified iTwin. For example, if there are no iModels for the specified iTwin +then the iModel Repository Uri will not be returned. + +The following Classes/SubClasses are supported. Classes in italics are auto generated. The others can be added manually using the POST endpoint. +- *iModels* +- *RealityData* +- *Storage* +- *Forms* +- *Issues* +- *SensorData* +- GeographicInformationSystem + + WebMapService + + WebMapTileService + + MapServer +- Construction + + Performance +- Subsurface + + EvoWorkspace + +{!Authorization.md!} + +### Authorization + +User must be an Organization Administrator for the Organization that owns the specified iTwin Repository or be an iTwin team member. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/itwins/v1/operations/get-repositories-by-itwin-id/displayName.md b/services/itwins/v1/operations/get-repositories-by-itwin-id/displayName.md new file mode 100644 index 0000000..a723e89 --- /dev/null +++ b/services/itwins/v1/operations/get-repositories-by-itwin-id/displayName.md @@ -0,0 +1 @@ +Get iTwin repositories \ No newline at end of file diff --git a/services/itwins/v1/operations/remove-itwin-from-my-favorites/description.md b/services/itwins/v1/operations/remove-itwin-from-my-favorites/description.md new file mode 100644 index 0000000..9cc48b9 --- /dev/null +++ b/services/itwins/v1/operations/remove-itwin-from-my-favorites/description.md @@ -0,0 +1,9 @@ +--- + +Remove an iTwin from the calling user's favorites list. + +{!Authorization.md!} + +{!iTwinMemberOfAuthorization.md!} + +--- diff --git a/services/itwins/v1/operations/remove-itwin-from-my-favorites/displayName.md b/services/itwins/v1/operations/remove-itwin-from-my-favorites/displayName.md new file mode 100644 index 0000000..b2e0cee --- /dev/null +++ b/services/itwins/v1/operations/remove-itwin-from-my-favorites/displayName.md @@ -0,0 +1 @@ +Remove iTwin from my favorites \ No newline at end of file diff --git a/services/itwins/v1/operations/update-itwin/description.md b/services/itwins/v1/operations/update-itwin/description.md new file mode 100644 index 0000000..d5fbc24 --- /dev/null +++ b/services/itwins/v1/operations/update-itwin/description.md @@ -0,0 +1,16 @@ +--- + +Update the specified iTwin. + +For updates, all properties are optional. The request payload should only contain the properties that you would like to update. + +{!Authorization.md!} + +### Authorization +The user must have the `itwins_modify` permission in order to modify iTwin properties. + +An Organization Administrator can modify iTwins owned by their Organization. + +{!iTwinAdminOnlyAuthorization.md!} + +--- diff --git a/services/itwins/v1/operations/update-itwin/displayName.md b/services/itwins/v1/operations/update-itwin/displayName.md new file mode 100644 index 0000000..270f069 --- /dev/null +++ b/services/itwins/v1/operations/update-itwin/displayName.md @@ -0,0 +1 @@ +Update iTwin \ No newline at end of file diff --git a/services/itwins/v1/operations/upload-itwin-image/description.md b/services/itwins/v1/operations/upload-itwin-image/description.md new file mode 100644 index 0000000..1365379 --- /dev/null +++ b/services/itwins/v1/operations/upload-itwin-image/description.md @@ -0,0 +1,26 @@ +--- + +Uploads an image for the specified iTwin. Maximum supported size is 5 megabytes. + +A small, thumbnail image will be automatically generated based on the uploaded image. For convenience, the link to this thumbnail is also returned in the 'image' property on the iTwin. + +Upload the image by adding a binary stream to the request body. You must specify the Content-Type header as either image/png or image/jpeg. + + C# Example: + ``` + var stream = File.OpenRead("c:/test.jpg"); + var streamContent = new StreamContent(stream); + streamContent.Headers.ContentType = new MediaTypeHeaderValue ("image/jpeg"); + var response = await httpClient.PutAsync($"{iTwinId}/image", streamContent); + ``` + +{!Authorization.md!} + +### Authorization +The user must have the `itwins_modify` permission on the iTwin in order to add an image to the iTwin. + +An Organization Administrator can modify any iTwins owned by their Organization. This allows Organization Administrators to upload an iTwin image. + +{!iTwinAdminOnlyAuthorization.md!} + +--- \ No newline at end of file diff --git a/services/itwins/v1/operations/upload-itwin-image/displayName.md b/services/itwins/v1/operations/upload-itwin-image/displayName.md new file mode 100644 index 0000000..08640db --- /dev/null +++ b/services/itwins/v1/operations/upload-itwin-image/displayName.md @@ -0,0 +1 @@ +Upload iTwin Image \ No newline at end of file diff --git a/services/library/v1/description.md b/services/library/v1/description.md new file mode 100644 index 0000000..b708f60 --- /dev/null +++ b/services/library/v1/description.md @@ -0,0 +1,3 @@ +Digital Library to manage digital components + +Digital component library and catalog management service. It allows users to efficiently manage and distribute their digital component libraries, providing their designers with approved, proprietary components as well as approved manufacturer's content. diff --git a/services/library/v1/operations/create-application/description.md b/services/library/v1/operations/create-application/description.md new file mode 100644 index 0000000..8580229 --- /dev/null +++ b/services/library/v1/operations/create-application/description.md @@ -0,0 +1,11 @@ +--- + +Creates an application in user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/create-application/displayName.md b/services/library/v1/operations/create-application/displayName.md new file mode 100644 index 0000000..237ac2e --- /dev/null +++ b/services/library/v1/operations/create-application/displayName.md @@ -0,0 +1 @@ +Create Application \ No newline at end of file diff --git a/services/library/v1/operations/create-catalog-document/description.md b/services/library/v1/operations/create-catalog-document/description.md new file mode 100644 index 0000000..73f4ee7 --- /dev/null +++ b/services/library/v1/operations/create-catalog-document/description.md @@ -0,0 +1,23 @@ +--- + +Creates a catalog document in user's organization context. + +### Notes + +To create a catalog document, displayName extension and purpose are required properties. + +Document purpose values are: +-Thumbnail +-Reference + +### Uploading Associated File + +To complete the process, associated file should be uploaded to fileUrl (property in response) and a subsequent update document request should be made by setting 'available' property to true. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/create-catalog-document/displayName.md b/services/library/v1/operations/create-catalog-document/displayName.md new file mode 100644 index 0000000..3b9e279 --- /dev/null +++ b/services/library/v1/operations/create-catalog-document/displayName.md @@ -0,0 +1 @@ +Create Catalog Document \ No newline at end of file diff --git a/services/library/v1/operations/create-catalog-weblink/description.md b/services/library/v1/operations/create-catalog-weblink/description.md new file mode 100644 index 0000000..f0faf66 --- /dev/null +++ b/services/library/v1/operations/create-catalog-weblink/description.md @@ -0,0 +1,15 @@ +--- + +Creates a catalog webLink in user's organization context. + +### Notes + +To create a catalog webLink, displayName and uri are required properties. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/create-catalog-weblink/displayName.md b/services/library/v1/operations/create-catalog-weblink/displayName.md new file mode 100644 index 0000000..332ff20 --- /dev/null +++ b/services/library/v1/operations/create-catalog-weblink/displayName.md @@ -0,0 +1 @@ +Create Catalog WebLink \ No newline at end of file diff --git a/services/library/v1/operations/create-catalog/description.md b/services/library/v1/operations/create-catalog/description.md new file mode 100644 index 0000000..c4dcaec --- /dev/null +++ b/services/library/v1/operations/create-catalog/description.md @@ -0,0 +1,11 @@ +--- + +Creates a catalog in user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/create-catalog/displayName.md b/services/library/v1/operations/create-catalog/displayName.md new file mode 100644 index 0000000..832920b --- /dev/null +++ b/services/library/v1/operations/create-catalog/displayName.md @@ -0,0 +1 @@ +Create Catalog \ No newline at end of file diff --git a/services/library/v1/operations/create-category/description.md b/services/library/v1/operations/create-category/description.md new file mode 100644 index 0000000..fbbb0bb --- /dev/null +++ b/services/library/v1/operations/create-category/description.md @@ -0,0 +1,11 @@ +--- + +Creates a category in user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/create-category/displayName.md b/services/library/v1/operations/create-category/displayName.md new file mode 100644 index 0000000..f9e5605 --- /dev/null +++ b/services/library/v1/operations/create-category/displayName.md @@ -0,0 +1 @@ +Create Category \ No newline at end of file diff --git a/services/library/v1/operations/create-component-document/description.md b/services/library/v1/operations/create-component-document/description.md new file mode 100644 index 0000000..9b1afa9 --- /dev/null +++ b/services/library/v1/operations/create-component-document/description.md @@ -0,0 +1,28 @@ +--- + +Creates a component document in user's organization context. + +### Notes + +To create a component document, displayName extension and purpose are required properties. + +Document purpose values are: +-Design +-Thumbnail +-Reference +-GalleryImage +-TypeCatalog + +### Uploading Associated File +To complete the process, associated file should be uploaded to fileUrl (property in response) and a subsequent update document request should be made by setting 'available' property to true. + +### Associated Documents +Document with purpose Thumbnail, GalleryImage and TypeCatalog can have associated design document, this should be a valid Id of existing design document. PreviousVersionId is only valid for Design documents and requires a valid Id of an existing design document, in case a design document needs up-version. In case there are multiple versions of the design document, only one design document and it's corresponding thumbnail can be active. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/create-component-document/displayName.md b/services/library/v1/operations/create-component-document/displayName.md new file mode 100644 index 0000000..9a00a3f --- /dev/null +++ b/services/library/v1/operations/create-component-document/displayName.md @@ -0,0 +1 @@ +Create Component Document \ No newline at end of file diff --git a/services/library/v1/operations/create-component-variation/description.md b/services/library/v1/operations/create-component-variation/description.md new file mode 100644 index 0000000..86068ff --- /dev/null +++ b/services/library/v1/operations/create-component-variation/description.md @@ -0,0 +1,22 @@ +--- + +Creates a component variation in user's organization context. + +### Notes + +To create a component variation, displayName is required property. If variation contains AdHocProperties, displayName and type are required properties of AdHocProperty. + +AdHocProperty type values are: +-StringType +-IntegerType +-DoubleType +-FloatType +-BooleanType + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/create-component-variation/displayName.md b/services/library/v1/operations/create-component-variation/displayName.md new file mode 100644 index 0000000..f048981 --- /dev/null +++ b/services/library/v1/operations/create-component-variation/displayName.md @@ -0,0 +1 @@ +Create Component Variation \ No newline at end of file diff --git a/services/library/v1/operations/create-component-weblink/description.md b/services/library/v1/operations/create-component-weblink/description.md new file mode 100644 index 0000000..040a5f4 --- /dev/null +++ b/services/library/v1/operations/create-component-weblink/description.md @@ -0,0 +1,15 @@ +--- + +Creates a component webLink in user's organization context. + +### Notes + +To create a component webLink, displayName and uri are required properties. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/create-component-weblink/displayName.md b/services/library/v1/operations/create-component-weblink/displayName.md new file mode 100644 index 0000000..b6a763e --- /dev/null +++ b/services/library/v1/operations/create-component-weblink/displayName.md @@ -0,0 +1 @@ +Create Component WebLink \ No newline at end of file diff --git a/services/library/v1/operations/create-component/description.md b/services/library/v1/operations/create-component/description.md new file mode 100644 index 0000000..dcf3284 --- /dev/null +++ b/services/library/v1/operations/create-component/description.md @@ -0,0 +1,26 @@ +--- + +Creates component in user's organization context. + +### Notes + +To create a component, displayName and status are required properties. + +Component status values are: +-Draft +-Published +-Checked +-Approved +-Archived +By default a component is created with Draft state, subsequently it can be updated to other states during component's validation cycle. Only published components can be used in project scope. + +### Associated Entities +A component can have associated entities, e.g catalogs, application, category, manufacturer. These values should be valid Ids of existing entities. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/create-component/displayName.md b/services/library/v1/operations/create-component/displayName.md new file mode 100644 index 0000000..bf65190 --- /dev/null +++ b/services/library/v1/operations/create-component/displayName.md @@ -0,0 +1 @@ +Create Component \ No newline at end of file diff --git a/services/library/v1/operations/create-manufacturer/description.md b/services/library/v1/operations/create-manufacturer/description.md new file mode 100644 index 0000000..ae0f003 --- /dev/null +++ b/services/library/v1/operations/create-manufacturer/description.md @@ -0,0 +1,11 @@ +--- + +Creates a manufacturer in user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/create-manufacturer/displayName.md b/services/library/v1/operations/create-manufacturer/displayName.md new file mode 100644 index 0000000..bc48c16 --- /dev/null +++ b/services/library/v1/operations/create-manufacturer/displayName.md @@ -0,0 +1 @@ +Create Manufacturer \ No newline at end of file diff --git a/services/library/v1/operations/delete-application/description.md b/services/library/v1/operations/delete-application/description.md new file mode 100644 index 0000000..818e9d5 --- /dev/null +++ b/services/library/v1/operations/delete-application/description.md @@ -0,0 +1,11 @@ +--- + +Deletes application from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/delete-application/displayName.md b/services/library/v1/operations/delete-application/displayName.md new file mode 100644 index 0000000..734347c --- /dev/null +++ b/services/library/v1/operations/delete-application/displayName.md @@ -0,0 +1 @@ +Delete Application \ No newline at end of file diff --git a/services/library/v1/operations/delete-catalog-document/description.md b/services/library/v1/operations/delete-catalog-document/description.md new file mode 100644 index 0000000..479057d --- /dev/null +++ b/services/library/v1/operations/delete-catalog-document/description.md @@ -0,0 +1,11 @@ +--- + +Deletes provided document for specified catalog from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/delete-catalog-document/displayName.md b/services/library/v1/operations/delete-catalog-document/displayName.md new file mode 100644 index 0000000..9ebeb80 --- /dev/null +++ b/services/library/v1/operations/delete-catalog-document/displayName.md @@ -0,0 +1 @@ +Delete Catalog Document \ No newline at end of file diff --git a/services/library/v1/operations/delete-catalog-weblink/description.md b/services/library/v1/operations/delete-catalog-weblink/description.md new file mode 100644 index 0000000..9c9166e --- /dev/null +++ b/services/library/v1/operations/delete-catalog-weblink/description.md @@ -0,0 +1,11 @@ +--- + +Deletes provided webLink for specified catalog from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/delete-catalog-weblink/displayName.md b/services/library/v1/operations/delete-catalog-weblink/displayName.md new file mode 100644 index 0000000..66c90b8 --- /dev/null +++ b/services/library/v1/operations/delete-catalog-weblink/displayName.md @@ -0,0 +1 @@ +Delete Catalog WebLink \ No newline at end of file diff --git a/services/library/v1/operations/delete-catalog/description.md b/services/library/v1/operations/delete-catalog/description.md new file mode 100644 index 0000000..22f3dca --- /dev/null +++ b/services/library/v1/operations/delete-catalog/description.md @@ -0,0 +1,11 @@ +--- + +Deletes catalog from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/delete-catalog/displayName.md b/services/library/v1/operations/delete-catalog/displayName.md new file mode 100644 index 0000000..6bcd138 --- /dev/null +++ b/services/library/v1/operations/delete-catalog/displayName.md @@ -0,0 +1 @@ +Delete Catalog \ No newline at end of file diff --git a/services/library/v1/operations/delete-category/description.md b/services/library/v1/operations/delete-category/description.md new file mode 100644 index 0000000..47363ce --- /dev/null +++ b/services/library/v1/operations/delete-category/description.md @@ -0,0 +1,11 @@ +--- + +Deletes category from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/delete-category/displayName.md b/services/library/v1/operations/delete-category/displayName.md new file mode 100644 index 0000000..c3dd29d --- /dev/null +++ b/services/library/v1/operations/delete-category/displayName.md @@ -0,0 +1 @@ +Delete Category \ No newline at end of file diff --git a/services/library/v1/operations/delete-component-document/description.md b/services/library/v1/operations/delete-component-document/description.md new file mode 100644 index 0000000..0d44ac6 --- /dev/null +++ b/services/library/v1/operations/delete-component-document/description.md @@ -0,0 +1,11 @@ +--- + +Deletes provided document for specified digital component from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/delete-component-document/displayName.md b/services/library/v1/operations/delete-component-document/displayName.md new file mode 100644 index 0000000..e1c40a2 --- /dev/null +++ b/services/library/v1/operations/delete-component-document/displayName.md @@ -0,0 +1 @@ +Delete Component Document \ No newline at end of file diff --git a/services/library/v1/operations/delete-component-variation/description.md b/services/library/v1/operations/delete-component-variation/description.md new file mode 100644 index 0000000..f57f238 --- /dev/null +++ b/services/library/v1/operations/delete-component-variation/description.md @@ -0,0 +1,11 @@ +--- + +Deletes provided variation for specified digital component from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/delete-component-variation/displayName.md b/services/library/v1/operations/delete-component-variation/displayName.md new file mode 100644 index 0000000..5e1880b --- /dev/null +++ b/services/library/v1/operations/delete-component-variation/displayName.md @@ -0,0 +1 @@ +Delete Component Variation \ No newline at end of file diff --git a/services/library/v1/operations/delete-component-weblink/description.md b/services/library/v1/operations/delete-component-weblink/description.md new file mode 100644 index 0000000..782c967 --- /dev/null +++ b/services/library/v1/operations/delete-component-weblink/description.md @@ -0,0 +1,11 @@ +--- + +Deletes provided webLink for specified digital component from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/delete-component-weblink/displayName.md b/services/library/v1/operations/delete-component-weblink/displayName.md new file mode 100644 index 0000000..fd433f4 --- /dev/null +++ b/services/library/v1/operations/delete-component-weblink/displayName.md @@ -0,0 +1 @@ +Delete Component WebLink \ No newline at end of file diff --git a/services/library/v1/operations/delete-component/description.md b/services/library/v1/operations/delete-component/description.md new file mode 100644 index 0000000..a1d4f5e --- /dev/null +++ b/services/library/v1/operations/delete-component/description.md @@ -0,0 +1,11 @@ +--- + +Deletes digital component from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/delete-component/displayName.md b/services/library/v1/operations/delete-component/displayName.md new file mode 100644 index 0000000..17ff24e --- /dev/null +++ b/services/library/v1/operations/delete-component/displayName.md @@ -0,0 +1 @@ +Delete Component \ No newline at end of file diff --git a/services/library/v1/operations/delete-manufacturer/description.md b/services/library/v1/operations/delete-manufacturer/description.md new file mode 100644 index 0000000..ef1d1bd --- /dev/null +++ b/services/library/v1/operations/delete-manufacturer/description.md @@ -0,0 +1,11 @@ +--- + +Deletes manufacturer from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/delete-manufacturer/displayName.md b/services/library/v1/operations/delete-manufacturer/displayName.md new file mode 100644 index 0000000..60fed06 --- /dev/null +++ b/services/library/v1/operations/delete-manufacturer/displayName.md @@ -0,0 +1 @@ +Delete Manufacturer \ No newline at end of file diff --git a/services/library/v1/operations/download-analytics/description.md b/services/library/v1/operations/download-analytics/description.md new file mode 100644 index 0000000..24c1e33 --- /dev/null +++ b/services/library/v1/operations/download-analytics/description.md @@ -0,0 +1,12 @@ +--- + +Retrieves components analytics information as csv downloadable file from user's organization context. +Response contains 'Content-Disposition' header containing name of the file to be downloaded. Query parameters 'startDate' and 'endDate' specify the period for which analytics should be downloaded, these are required parameters and must be in this format yyyy-MM-dd'T'HH:mm:ss.fff'Z'. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/download-analytics/displayName.md b/services/library/v1/operations/download-analytics/displayName.md new file mode 100644 index 0000000..eb36716 --- /dev/null +++ b/services/library/v1/operations/download-analytics/displayName.md @@ -0,0 +1 @@ +Download Analytics \ No newline at end of file diff --git a/services/library/v1/operations/get-application/description.md b/services/library/v1/operations/get-application/description.md new file mode 100644 index 0000000..b1b2e32 --- /dev/null +++ b/services/library/v1/operations/get-application/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves Application from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-application/displayName.md b/services/library/v1/operations/get-application/displayName.md new file mode 100644 index 0000000..4a3ae43 --- /dev/null +++ b/services/library/v1/operations/get-application/displayName.md @@ -0,0 +1 @@ +Get Application \ No newline at end of file diff --git a/services/library/v1/operations/get-applications/description.md b/services/library/v1/operations/get-applications/description.md new file mode 100644 index 0000000..9454e95 --- /dev/null +++ b/services/library/v1/operations/get-applications/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves applications from user's organization context. + +### Notes + +The response returns only 50 entities.To retrieve all the entities, continuation token should be used in the subsequent requests, which is returned in the response under _links as part of next request url. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-applications/displayName.md b/services/library/v1/operations/get-applications/displayName.md new file mode 100644 index 0000000..76be9d3 --- /dev/null +++ b/services/library/v1/operations/get-applications/displayName.md @@ -0,0 +1 @@ +Get Applications \ No newline at end of file diff --git a/services/library/v1/operations/get-brand-component-documents/description.md b/services/library/v1/operations/get-brand-component-documents/description.md new file mode 100644 index 0000000..843dffd --- /dev/null +++ b/services/library/v1/operations/get-brand-component-documents/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves documents for specified digital component from brand. + +### Downloading Associated File + +Associated file url can be found in fileUrl property returned in the response. + +{!Authorization.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-brand-component-documents/displayName.md b/services/library/v1/operations/get-brand-component-documents/displayName.md new file mode 100644 index 0000000..7ceb8e5 --- /dev/null +++ b/services/library/v1/operations/get-brand-component-documents/displayName.md @@ -0,0 +1 @@ +Get Brand Component Documents \ No newline at end of file diff --git a/services/library/v1/operations/get-brand-component-variations/description.md b/services/library/v1/operations/get-brand-component-variations/description.md new file mode 100644 index 0000000..b78586c --- /dev/null +++ b/services/library/v1/operations/get-brand-component-variations/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves variations for specified digital component from brand. + +{!Authorization.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-brand-component-variations/displayName.md b/services/library/v1/operations/get-brand-component-variations/displayName.md new file mode 100644 index 0000000..ede106f --- /dev/null +++ b/services/library/v1/operations/get-brand-component-variations/displayName.md @@ -0,0 +1 @@ +Get Brand Component Variations \ No newline at end of file diff --git a/services/library/v1/operations/get-brand-component-weblinks/description.md b/services/library/v1/operations/get-brand-component-weblinks/description.md new file mode 100644 index 0000000..0f63d43 --- /dev/null +++ b/services/library/v1/operations/get-brand-component-weblinks/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves webLinks for specified digital component from brand. + +{!Authorization.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-brand-component-weblinks/displayName.md b/services/library/v1/operations/get-brand-component-weblinks/displayName.md new file mode 100644 index 0000000..4d0b9da --- /dev/null +++ b/services/library/v1/operations/get-brand-component-weblinks/displayName.md @@ -0,0 +1 @@ +Get Brand Component WebLinks \ No newline at end of file diff --git a/services/library/v1/operations/get-brand-components/description.md b/services/library/v1/operations/get-brand-components/description.md new file mode 100644 index 0000000..f9b0df1 --- /dev/null +++ b/services/library/v1/operations/get-brand-components/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves digital components from brand. + +{!Authorization.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-brand-components/displayName.md b/services/library/v1/operations/get-brand-components/displayName.md new file mode 100644 index 0000000..cc20583 --- /dev/null +++ b/services/library/v1/operations/get-brand-components/displayName.md @@ -0,0 +1 @@ +Get Brand Components \ No newline at end of file diff --git a/services/library/v1/operations/get-brand/description.md b/services/library/v1/operations/get-brand/description.md new file mode 100644 index 0000000..b9038c3 --- /dev/null +++ b/services/library/v1/operations/get-brand/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves brand from library. + +{!Authorization.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-brand/displayName.md b/services/library/v1/operations/get-brand/displayName.md new file mode 100644 index 0000000..4309c97 --- /dev/null +++ b/services/library/v1/operations/get-brand/displayName.md @@ -0,0 +1 @@ +Get Brand \ No newline at end of file diff --git a/services/library/v1/operations/get-brands/description.md b/services/library/v1/operations/get-brands/description.md new file mode 100644 index 0000000..b58caf9 --- /dev/null +++ b/services/library/v1/operations/get-brands/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves brands. + +### Response + +By default, each entity in the returned list will have only the id and display name. + +A full representation of each entity can be returned by specifying the *prefer* header that includes a value of *return=representation*. + +{!Authorization.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-brands/displayName.md b/services/library/v1/operations/get-brands/displayName.md new file mode 100644 index 0000000..e4f82f0 --- /dev/null +++ b/services/library/v1/operations/get-brands/displayName.md @@ -0,0 +1 @@ +Get Brands \ No newline at end of file diff --git a/services/library/v1/operations/get-catalog-document/description.md b/services/library/v1/operations/get-catalog-document/description.md new file mode 100644 index 0000000..344df9e --- /dev/null +++ b/services/library/v1/operations/get-catalog-document/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves documents for specified digital catalog from user's organization context. + +### Downloading Associated File + +Associated file url can be found in fileUrl property returned in the response. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-catalog-document/displayName.md b/services/library/v1/operations/get-catalog-document/displayName.md new file mode 100644 index 0000000..5627511 --- /dev/null +++ b/services/library/v1/operations/get-catalog-document/displayName.md @@ -0,0 +1 @@ +Get Catalog Document \ No newline at end of file diff --git a/services/library/v1/operations/get-catalog-documents/description.md b/services/library/v1/operations/get-catalog-documents/description.md new file mode 100644 index 0000000..344df9e --- /dev/null +++ b/services/library/v1/operations/get-catalog-documents/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves documents for specified digital catalog from user's organization context. + +### Downloading Associated File + +Associated file url can be found in fileUrl property returned in the response. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-catalog-documents/displayName.md b/services/library/v1/operations/get-catalog-documents/displayName.md new file mode 100644 index 0000000..056f98e --- /dev/null +++ b/services/library/v1/operations/get-catalog-documents/displayName.md @@ -0,0 +1 @@ +Get Catalog Documents \ No newline at end of file diff --git a/services/library/v1/operations/get-catalog-weblink/description.md b/services/library/v1/operations/get-catalog-weblink/description.md new file mode 100644 index 0000000..6d32de3 --- /dev/null +++ b/services/library/v1/operations/get-catalog-weblink/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves webLink for specified digital catalog from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-catalog-weblink/displayName.md b/services/library/v1/operations/get-catalog-weblink/displayName.md new file mode 100644 index 0000000..dd23b93 --- /dev/null +++ b/services/library/v1/operations/get-catalog-weblink/displayName.md @@ -0,0 +1 @@ +Get Catalog WebLink \ No newline at end of file diff --git a/services/library/v1/operations/get-catalog-weblinks/description.md b/services/library/v1/operations/get-catalog-weblinks/description.md new file mode 100644 index 0000000..486835a --- /dev/null +++ b/services/library/v1/operations/get-catalog-weblinks/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves webLinks for specified digital catalog from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-catalog-weblinks/displayName.md b/services/library/v1/operations/get-catalog-weblinks/displayName.md new file mode 100644 index 0000000..ad27925 --- /dev/null +++ b/services/library/v1/operations/get-catalog-weblinks/displayName.md @@ -0,0 +1 @@ +Get Catalog WebLinks \ No newline at end of file diff --git a/services/library/v1/operations/get-catalog/description.md b/services/library/v1/operations/get-catalog/description.md new file mode 100644 index 0000000..39320a6 --- /dev/null +++ b/services/library/v1/operations/get-catalog/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves catalog from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-catalog/displayName.md b/services/library/v1/operations/get-catalog/displayName.md new file mode 100644 index 0000000..771de9e --- /dev/null +++ b/services/library/v1/operations/get-catalog/displayName.md @@ -0,0 +1 @@ +Get Catalog \ No newline at end of file diff --git a/services/library/v1/operations/get-catalogs/description.md b/services/library/v1/operations/get-catalogs/description.md new file mode 100644 index 0000000..0cc2906 --- /dev/null +++ b/services/library/v1/operations/get-catalogs/description.md @@ -0,0 +1,17 @@ +--- + +Retrieves digital catalogs from user's organization context. + +### Response + +By default, each entity in the returned list will have only the id and display name. + +A full representation of each entity can be returned by specifying the *prefer* header that includes a value of *return=representation*. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-catalogs/displayName.md b/services/library/v1/operations/get-catalogs/displayName.md new file mode 100644 index 0000000..a463ec4 --- /dev/null +++ b/services/library/v1/operations/get-catalogs/displayName.md @@ -0,0 +1 @@ +Get Catalogs \ No newline at end of file diff --git a/services/library/v1/operations/get-categories/description.md b/services/library/v1/operations/get-categories/description.md new file mode 100644 index 0000000..0551ff1 --- /dev/null +++ b/services/library/v1/operations/get-categories/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves categories from user's organization context. + +### Notes + +The response returns only 50 entities.To retrieve all the entities, continuation token should be used in the subsequent requests, which is returned in the response under _links as part of next request url. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-categories/displayName.md b/services/library/v1/operations/get-categories/displayName.md new file mode 100644 index 0000000..a5a297c --- /dev/null +++ b/services/library/v1/operations/get-categories/displayName.md @@ -0,0 +1 @@ +Get Categories \ No newline at end of file diff --git a/services/library/v1/operations/get-category/description.md b/services/library/v1/operations/get-category/description.md new file mode 100644 index 0000000..f66bde4 --- /dev/null +++ b/services/library/v1/operations/get-category/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves category from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-category/displayName.md b/services/library/v1/operations/get-category/displayName.md new file mode 100644 index 0000000..6f735fd --- /dev/null +++ b/services/library/v1/operations/get-category/displayName.md @@ -0,0 +1 @@ +Get Category \ No newline at end of file diff --git a/services/library/v1/operations/get-component-document/description.md b/services/library/v1/operations/get-component-document/description.md new file mode 100644 index 0000000..7bac81a --- /dev/null +++ b/services/library/v1/operations/get-component-document/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves documents for specified digital component from user's organization or project context. + +### Downloading Associated File + +Associated file url can be found in fileUrl property returned in the response. + +{!Authorization.md!} + +{!LibraryProjectPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-component-document/displayName.md b/services/library/v1/operations/get-component-document/displayName.md new file mode 100644 index 0000000..0d3a5cb --- /dev/null +++ b/services/library/v1/operations/get-component-document/displayName.md @@ -0,0 +1 @@ +Get Component Document \ No newline at end of file diff --git a/services/library/v1/operations/get-component-documents/description.md b/services/library/v1/operations/get-component-documents/description.md new file mode 100644 index 0000000..7bac81a --- /dev/null +++ b/services/library/v1/operations/get-component-documents/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves documents for specified digital component from user's organization or project context. + +### Downloading Associated File + +Associated file url can be found in fileUrl property returned in the response. + +{!Authorization.md!} + +{!LibraryProjectPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-component-documents/displayName.md b/services/library/v1/operations/get-component-documents/displayName.md new file mode 100644 index 0000000..c8208dc --- /dev/null +++ b/services/library/v1/operations/get-component-documents/displayName.md @@ -0,0 +1 @@ +Get Component Documents \ No newline at end of file diff --git a/services/library/v1/operations/get-component-variation/description.md b/services/library/v1/operations/get-component-variation/description.md new file mode 100644 index 0000000..50e6770 --- /dev/null +++ b/services/library/v1/operations/get-component-variation/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves variations for specified digital component from user's organization or project context. + +{!Authorization.md!} + +{!LibraryProjectPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-component-variation/displayName.md b/services/library/v1/operations/get-component-variation/displayName.md new file mode 100644 index 0000000..fe0c5fc --- /dev/null +++ b/services/library/v1/operations/get-component-variation/displayName.md @@ -0,0 +1 @@ +Get Component Variation \ No newline at end of file diff --git a/services/library/v1/operations/get-component-variations/description.md b/services/library/v1/operations/get-component-variations/description.md new file mode 100644 index 0000000..50e6770 --- /dev/null +++ b/services/library/v1/operations/get-component-variations/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves variations for specified digital component from user's organization or project context. + +{!Authorization.md!} + +{!LibraryProjectPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-component-variations/displayName.md b/services/library/v1/operations/get-component-variations/displayName.md new file mode 100644 index 0000000..dd4066c --- /dev/null +++ b/services/library/v1/operations/get-component-variations/displayName.md @@ -0,0 +1 @@ +Get Component Variations \ No newline at end of file diff --git a/services/library/v1/operations/get-component-weblink/description.md b/services/library/v1/operations/get-component-weblink/description.md new file mode 100644 index 0000000..1e51c2e --- /dev/null +++ b/services/library/v1/operations/get-component-weblink/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves webLink for specified digital component from user's organization or project context. + +{!Authorization.md!} + +{!LibraryProjectPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-component-weblink/displayName.md b/services/library/v1/operations/get-component-weblink/displayName.md new file mode 100644 index 0000000..abca0b0 --- /dev/null +++ b/services/library/v1/operations/get-component-weblink/displayName.md @@ -0,0 +1 @@ +Get Component WebLink \ No newline at end of file diff --git a/services/library/v1/operations/get-component-weblinks/description.md b/services/library/v1/operations/get-component-weblinks/description.md new file mode 100644 index 0000000..45b5f75 --- /dev/null +++ b/services/library/v1/operations/get-component-weblinks/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves webLinks for specified digital component from user's organization or project context. + +{!Authorization.md!} + +{!LibraryProjectPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-component-weblinks/displayName.md b/services/library/v1/operations/get-component-weblinks/displayName.md new file mode 100644 index 0000000..99e9fc2 --- /dev/null +++ b/services/library/v1/operations/get-component-weblinks/displayName.md @@ -0,0 +1 @@ +Get Component WebLinks \ No newline at end of file diff --git a/services/library/v1/operations/get-component/description.md b/services/library/v1/operations/get-component/description.md new file mode 100644 index 0000000..b8bf078 --- /dev/null +++ b/services/library/v1/operations/get-component/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves digital component from user's organization or project context. + +{!Authorization.md!} + +{!LibraryProjectPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-component/displayName.md b/services/library/v1/operations/get-component/displayName.md new file mode 100644 index 0000000..107dff0 --- /dev/null +++ b/services/library/v1/operations/get-component/displayName.md @@ -0,0 +1 @@ +Get Component \ No newline at end of file diff --git a/services/library/v1/operations/get-components/description.md b/services/library/v1/operations/get-components/description.md new file mode 100644 index 0000000..b9f4b67 --- /dev/null +++ b/services/library/v1/operations/get-components/description.md @@ -0,0 +1,17 @@ +--- + +Retrieves digital components from user's organization or project context. + +### Response + +By default, each entity in the returned list will have only the id and display name. + +A full representation of each entity can be returned by specifying the *prefer* header that includes a value of *return=representation*. + +{!Authorization.md!} + +{!LibraryProjectPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-components/displayName.md b/services/library/v1/operations/get-components/displayName.md new file mode 100644 index 0000000..2df61c3 --- /dev/null +++ b/services/library/v1/operations/get-components/displayName.md @@ -0,0 +1 @@ +Get Components \ No newline at end of file diff --git a/services/library/v1/operations/get-job/description.md b/services/library/v1/operations/get-job/description.md new file mode 100644 index 0000000..8316c21 --- /dev/null +++ b/services/library/v1/operations/get-job/description.md @@ -0,0 +1,23 @@ +--- + +Retrieves job from user's organization context, a job contains information required to track long running activity, e.g., UploadComponent. + +### Notes + +Job Status values are: + +-Success +-Error +-InProgress +-Queued +-Aborted +-Canceled +-PendingCancel + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-job/displayName.md b/services/library/v1/operations/get-job/displayName.md new file mode 100644 index 0000000..9353266 --- /dev/null +++ b/services/library/v1/operations/get-job/displayName.md @@ -0,0 +1 @@ +Get Job \ No newline at end of file diff --git a/services/library/v1/operations/get-manufacturer/description.md b/services/library/v1/operations/get-manufacturer/description.md new file mode 100644 index 0000000..c918912 --- /dev/null +++ b/services/library/v1/operations/get-manufacturer/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves manufacturer from user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-manufacturer/displayName.md b/services/library/v1/operations/get-manufacturer/displayName.md new file mode 100644 index 0000000..0408b21 --- /dev/null +++ b/services/library/v1/operations/get-manufacturer/displayName.md @@ -0,0 +1 @@ +Get Manufacturer \ No newline at end of file diff --git a/services/library/v1/operations/get-manufacturers/description.md b/services/library/v1/operations/get-manufacturers/description.md new file mode 100644 index 0000000..a27b0cb --- /dev/null +++ b/services/library/v1/operations/get-manufacturers/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves manufacturers from user's organization context. + +### Notes + +The response returns only 50 entities.To retrieve all the entities, continuation token should be used in the subsequent requests, which is returned in the response under _links as part of next request url. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/get-manufacturers/displayName.md b/services/library/v1/operations/get-manufacturers/displayName.md new file mode 100644 index 0000000..c9f877a --- /dev/null +++ b/services/library/v1/operations/get-manufacturers/displayName.md @@ -0,0 +1 @@ +Get Manufacturers \ No newline at end of file diff --git a/services/library/v1/operations/update-application/description.md b/services/library/v1/operations/update-application/description.md new file mode 100644 index 0000000..0d7a700 --- /dev/null +++ b/services/library/v1/operations/update-application/description.md @@ -0,0 +1,15 @@ +--- + +Updates an application in user's organization context. + +### Notes + +To update an application, request body must contain all the properties desired for the application since this will replace existing application with current application definition. DisplayName and version are required properties. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/update-application/displayName.md b/services/library/v1/operations/update-application/displayName.md new file mode 100644 index 0000000..9795d0f --- /dev/null +++ b/services/library/v1/operations/update-application/displayName.md @@ -0,0 +1 @@ +Update Application \ No newline at end of file diff --git a/services/library/v1/operations/update-catalog-document/description.md b/services/library/v1/operations/update-catalog-document/description.md new file mode 100644 index 0000000..b025edf --- /dev/null +++ b/services/library/v1/operations/update-catalog-document/description.md @@ -0,0 +1,19 @@ +--- + +Updates a catalog document in user's organization context. + +### Notes + +To update a document, request body must contain all the properties desired for the document since this will replace existing document with current document definition. DisplayName extension and purpose are required properties. + +Document purpose values are: +-Thumbnail +-Reference + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/update-catalog-document/displayName.md b/services/library/v1/operations/update-catalog-document/displayName.md new file mode 100644 index 0000000..4b4ae38 --- /dev/null +++ b/services/library/v1/operations/update-catalog-document/displayName.md @@ -0,0 +1 @@ +Update Catalog Document \ No newline at end of file diff --git a/services/library/v1/operations/update-catalog-weblink/description.md b/services/library/v1/operations/update-catalog-weblink/description.md new file mode 100644 index 0000000..dd99b2d --- /dev/null +++ b/services/library/v1/operations/update-catalog-weblink/description.md @@ -0,0 +1,15 @@ +--- + +Updates a catalog webLink in user's organization context. + +### Notes + +To update a webLink, request body must contain all the properties desired for the webLink since this will replace existing webLink with current webLink definition. DisplayName and uri are required properties. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/update-catalog-weblink/displayName.md b/services/library/v1/operations/update-catalog-weblink/displayName.md new file mode 100644 index 0000000..0a42c70 --- /dev/null +++ b/services/library/v1/operations/update-catalog-weblink/displayName.md @@ -0,0 +1 @@ +Update Catalog WebLink \ No newline at end of file diff --git a/services/library/v1/operations/update-catalog/description.md b/services/library/v1/operations/update-catalog/description.md new file mode 100644 index 0000000..33c5097 --- /dev/null +++ b/services/library/v1/operations/update-catalog/description.md @@ -0,0 +1,15 @@ +--- + +Updates a catalog in user's organization context. + +### Notes + +To update a catalog, request body must contain all the properties desired for the catalog since this will replace existing catalog with current catalog definition. DisplayName is required property. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/update-catalog/displayName.md b/services/library/v1/operations/update-catalog/displayName.md new file mode 100644 index 0000000..2fff8d5 --- /dev/null +++ b/services/library/v1/operations/update-catalog/displayName.md @@ -0,0 +1 @@ +Update Catalog \ No newline at end of file diff --git a/services/library/v1/operations/update-category/description.md b/services/library/v1/operations/update-category/description.md new file mode 100644 index 0000000..d8dea0b --- /dev/null +++ b/services/library/v1/operations/update-category/description.md @@ -0,0 +1,11 @@ +--- + +Updates a category in user's organization context. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/update-category/displayName.md b/services/library/v1/operations/update-category/displayName.md new file mode 100644 index 0000000..17550d3 --- /dev/null +++ b/services/library/v1/operations/update-category/displayName.md @@ -0,0 +1 @@ +Update Category \ No newline at end of file diff --git a/services/library/v1/operations/update-component-document/description.md b/services/library/v1/operations/update-component-document/description.md new file mode 100644 index 0000000..2bb1417 --- /dev/null +++ b/services/library/v1/operations/update-component-document/description.md @@ -0,0 +1,25 @@ +--- + +Updates a component document in user's organization context. + +### Notes + +To update a document request body must contain all the properties desired for the document since this will replace existing document with current document definition. DisplayName extension and purpose are required properties. + +Document purpose values are: +-Design +-Thumbnail +-Reference +-GalleryImage +-TypeCatalog + +### Associated Documents +Document with purpose Thumbnail, GalleryImage and TypeCatalog can have associated design document, this should be a valid Id of existing design document. PreviousVersionId is only valid for Design documents and requires a valid Id of an existing design document, in case a design document needs up-version. In case there are multiple versions of the design document, only one design document and it's corresponding thumbnail can be active. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/update-component-document/displayName.md b/services/library/v1/operations/update-component-document/displayName.md new file mode 100644 index 0000000..7195491 --- /dev/null +++ b/services/library/v1/operations/update-component-document/displayName.md @@ -0,0 +1 @@ +Update Component Document \ No newline at end of file diff --git a/services/library/v1/operations/update-component-variation/description.md b/services/library/v1/operations/update-component-variation/description.md new file mode 100644 index 0000000..948cb18 --- /dev/null +++ b/services/library/v1/operations/update-component-variation/description.md @@ -0,0 +1,22 @@ +--- + +Updates a component variation in user's organization context. + +### Notes + +To update a variation request body must contain all the properties desired for the variation since this will replace existing variation with current variation definition. DisplayName is required property. If variation contains AdHocProperties, displayName and type are required properties of AdHocProperty. + +AdHocProperty type values are: +-StringType +-IntegerType +-DoubleType +-FloatType +-BooleanType + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/update-component-variation/displayName.md b/services/library/v1/operations/update-component-variation/displayName.md new file mode 100644 index 0000000..5c25242 --- /dev/null +++ b/services/library/v1/operations/update-component-variation/displayName.md @@ -0,0 +1 @@ +Update Component Variation \ No newline at end of file diff --git a/services/library/v1/operations/update-component-weblink/description.md b/services/library/v1/operations/update-component-weblink/description.md new file mode 100644 index 0000000..78be036 --- /dev/null +++ b/services/library/v1/operations/update-component-weblink/description.md @@ -0,0 +1,15 @@ +--- + +Updates a component webLink in user's organization context. + +### Notes + +To update a webLink, request body must contain all the properties desired for the webLink since this will replace existing webLink with current webLink definition. DisplayName and uri are required properties. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/update-component-weblink/displayName.md b/services/library/v1/operations/update-component-weblink/displayName.md new file mode 100644 index 0000000..ddbb4d4 --- /dev/null +++ b/services/library/v1/operations/update-component-weblink/displayName.md @@ -0,0 +1 @@ +Update Component WebLink \ No newline at end of file diff --git a/services/library/v1/operations/update-component/description.md b/services/library/v1/operations/update-component/description.md new file mode 100644 index 0000000..210da19 --- /dev/null +++ b/services/library/v1/operations/update-component/description.md @@ -0,0 +1,25 @@ +--- + +Updates existing component in user's organization context. + +### Notes + +To update a component request body must contain all the properties desired for the component since this will replace existing component with current component definition. DisplayName and status are required properties. + +Component status values are: +-Draft +-Published +-Checked +-Approved +-Archived + +### Associated Entities +A component can have associated entities, e.g catalogs, application, category, manufacturer. These values should be valid Ids of existing entities. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/update-component/displayName.md b/services/library/v1/operations/update-component/displayName.md new file mode 100644 index 0000000..c1fea72 --- /dev/null +++ b/services/library/v1/operations/update-component/displayName.md @@ -0,0 +1 @@ +Update Component \ No newline at end of file diff --git a/services/library/v1/operations/update-manufacturer/description.md b/services/library/v1/operations/update-manufacturer/description.md new file mode 100644 index 0000000..6e1deb6 --- /dev/null +++ b/services/library/v1/operations/update-manufacturer/description.md @@ -0,0 +1,15 @@ +--- + +Updates a manufacturer in user's organization context. + +### Notes + +To update a manufacturer, request body must contain all the properties desired for the manufacturer since this will replace existing manufacturer with current manufacturer definition. DisplayName is required property. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/update-manufacturer/displayName.md b/services/library/v1/operations/update-manufacturer/displayName.md new file mode 100644 index 0000000..ae19884 --- /dev/null +++ b/services/library/v1/operations/update-manufacturer/displayName.md @@ -0,0 +1 @@ +Update Manufacturer \ No newline at end of file diff --git a/services/library/v1/operations/upload-component/description.md b/services/library/v1/operations/upload-component/description.md new file mode 100644 index 0000000..6458e58 --- /dev/null +++ b/services/library/v1/operations/upload-component/description.md @@ -0,0 +1,23 @@ +--- + +Uploads a design file to create a digital component. + +### Notes + +This endpoint is to create a component from design file. Supported file extensions are '.rfa', '.dgn' and '.cel'. This is a long running activity +that runs in background after the endpoint is called and creates a component by extracting information from the design file, e.g., category, +application, manufacturer and other metadata found in the design file. Response object has links to upload the design file or type catalog file, if +specified. Client must upload type catalog file before uploading design file. Once files are uploaded, component creation activity can be tracked +using job endpoint returned in the 'Location' header. Once job succeeds, component can be fetched using 'component' property provided under _links +in job endpoint response. + +### Referenced Entities +A component can have referenced entities, e.g catalogs. These values should be valid Ids of existing entities. + +{!Authorization.md!} + +{!LibraryPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/library/v1/operations/upload-component/displayName.md b/services/library/v1/operations/upload-component/displayName.md new file mode 100644 index 0000000..71780bd --- /dev/null +++ b/services/library/v1/operations/upload-component/displayName.md @@ -0,0 +1 @@ +Upload Component \ No newline at end of file diff --git a/services/mesh-export/v1/description.md b/services/mesh-export/v1/description.md new file mode 100644 index 0000000..7277699 --- /dev/null +++ b/services/mesh-export/v1/description.md @@ -0,0 +1 @@ +Export iModel 3D content to GLTF format. \ No newline at end of file diff --git a/services/mesh-export/v1/operations/delete-export/description.md b/services/mesh-export/v1/operations/delete-export/description.md new file mode 100644 index 0000000..df792fe --- /dev/null +++ b/services/mesh-export/v1/operations/delete-export/description.md @@ -0,0 +1,7 @@ +--- + +Deletes an export that is completed or invalid. + +{!Authorization.md!} + +--- diff --git a/services/mesh-export/v1/operations/delete-export/displayName.md b/services/mesh-export/v1/operations/delete-export/displayName.md new file mode 100644 index 0000000..0efacea --- /dev/null +++ b/services/mesh-export/v1/operations/delete-export/displayName.md @@ -0,0 +1 @@ +Delete Export \ No newline at end of file diff --git a/services/mesh-export/v1/operations/get-export/description.md b/services/mesh-export/v1/operations/get-export/description.md new file mode 100644 index 0000000..8f98b9d --- /dev/null +++ b/services/mesh-export/v1/operations/get-export/description.md @@ -0,0 +1,18 @@ +--- + +Retrieves the information for a single export. Exports are persisted until deleted. + +When a mesh export succeeds, the `_links.mesh` returns a URL to download the resulting mesh from the blob container. You can list the contents of the container by appending the query parameters `restype=container&comp=list` to the URL. Note: Anyone with this URL has access to download the resultant mesh, share with care. The link is valid for one hour. + +### GLTF Meshes + +Exporting `GLTF` meshes produces two files: `Export.gltf` and `Export.bin`. To download these files you must split the URL provided in `_links.mesh.href` and append the file name to the URL before the query parameters. For example: +`SASUrl/Export.gltf?SASKey` and `SASURL/Export.bin?SASKey`. Use these URLs to download the relevant files. Note: The files will always be named `Export.gltf` and `Export.bin`. + +### 3DFT Meshes + +When exporting `3DFT` meshes, feed the URL to the [Unreal Engine Plugin](https://github.com/iTwin/unreal-engine-3dft-plugin) to stream the mesh in Unreal. + +{!Authorization.md!} + +--- diff --git a/services/mesh-export/v1/operations/get-export/displayName.md b/services/mesh-export/v1/operations/get-export/displayName.md new file mode 100644 index 0000000..bda02c6 --- /dev/null +++ b/services/mesh-export/v1/operations/get-export/displayName.md @@ -0,0 +1 @@ +Get Export \ No newline at end of file diff --git a/services/mesh-export/v1/operations/get-exports/description.md b/services/mesh-export/v1/operations/get-exports/description.md new file mode 100644 index 0000000..ccc19af --- /dev/null +++ b/services/mesh-export/v1/operations/get-exports/description.md @@ -0,0 +1,7 @@ +--- + +Returns a list of all exports previously requested by the user that have not expired and their statuses. + +{!Authorization.md!} + +--- diff --git a/services/mesh-export/v1/operations/get-exports/displayName.md b/services/mesh-export/v1/operations/get-exports/displayName.md new file mode 100644 index 0000000..638cd7a --- /dev/null +++ b/services/mesh-export/v1/operations/get-exports/displayName.md @@ -0,0 +1 @@ +Get Exports \ No newline at end of file diff --git a/services/mesh-export/v1/operations/start-export/description.md b/services/mesh-export/v1/operations/start-export/description.md new file mode 100644 index 0000000..968df5f --- /dev/null +++ b/services/mesh-export/v1/operations/start-export/description.md @@ -0,0 +1,18 @@ +--- + +Start a mesh export from the iModel. Exports are persisted until deleted. + +When a mesh export succeeds, the `_links.mesh` returns a URL to download the resulting mesh from the blob container. You can list the contents of the container by appending the query parameters `restype=container&comp=list` to the URL. Note: Anyone with this URL has access to download the resultant mesh, share with care. The link is valid for one hour. + +### GLTF Meshes + +Exporting `GLTF` meshes produces two files: `Export.gltf` and `Export.bin`. To download these files you must split the URL provided in `_links.mesh.href` and append the file name to the URL before the query parameters. For example: +`SASUrl/Export.gltf?SASKey` and `SASURL/Export.bin?SASKey`. Use these URLs to download the relevant files. Note: The files will always be named `Export.gltf` and `Export.bin`. + +### 3DFT Meshes + +When exporting `3DFT` meshes, feed the URL to the [Unreal Engine Plugin](https://github.com/iTwin/unreal-engine-3dft-plugin) to stream the mesh in Unreal. + +{!Authorization.md!} + +--- diff --git a/services/mesh-export/v1/operations/start-export/displayName.md b/services/mesh-export/v1/operations/start-export/displayName.md new file mode 100644 index 0000000..67975ac --- /dev/null +++ b/services/mesh-export/v1/operations/start-export/displayName.md @@ -0,0 +1 @@ +Start Export \ No newline at end of file diff --git a/services/named-groups/v1/operations/create-group/description.md b/services/named-groups/v1/operations/create-group/description.md new file mode 100644 index 0000000..22dde5a --- /dev/null +++ b/services/named-groups/v1/operations/create-group/description.md @@ -0,0 +1,13 @@ +--- + +Creates a group. A group is a collection of design elements from an iModel represented by an [ECSQL](https://www.itwinjs.org/learning/ecsql/) query. + +{!GroupQuery.md!} + +{!Authorization.md!} + +{!NamedGroupsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/named-groups/v1/operations/create-group/displayName.md b/services/named-groups/v1/operations/create-group/displayName.md new file mode 100644 index 0000000..69cd6d6 --- /dev/null +++ b/services/named-groups/v1/operations/create-group/displayName.md @@ -0,0 +1 @@ +Create Group \ No newline at end of file diff --git a/services/named-groups/v1/operations/delete-group/description.md b/services/named-groups/v1/operations/delete-group/description.md new file mode 100644 index 0000000..f0a86ba --- /dev/null +++ b/services/named-groups/v1/operations/delete-group/description.md @@ -0,0 +1,13 @@ +--- + +Deletes a group. + +{!Authorization.md!} + +{!NamedGroupsPermissions.md!} + +{!RateLimits.md!} + +{!ExtractionRowLimiting.md!} + +--- diff --git a/services/named-groups/v1/operations/delete-group/displayName.md b/services/named-groups/v1/operations/delete-group/displayName.md new file mode 100644 index 0000000..054678e --- /dev/null +++ b/services/named-groups/v1/operations/delete-group/displayName.md @@ -0,0 +1 @@ +Delete Group \ No newline at end of file diff --git a/services/named-groups/v1/operations/get-group/description.md b/services/named-groups/v1/operations/get-group/description.md new file mode 100644 index 0000000..17dd13a --- /dev/null +++ b/services/named-groups/v1/operations/get-group/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves a group. + +{!GroupQuery.md!} + +{!Authorization.md!} + +{!NamedGroupsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/named-groups/v1/operations/get-group/displayName.md b/services/named-groups/v1/operations/get-group/displayName.md new file mode 100644 index 0000000..b718712 --- /dev/null +++ b/services/named-groups/v1/operations/get-group/displayName.md @@ -0,0 +1 @@ +Get Group \ No newline at end of file diff --git a/services/named-groups/v1/operations/get-itwin-groups/description.md b/services/named-groups/v1/operations/get-itwin-groups/description.md new file mode 100644 index 0000000..342e4cb --- /dev/null +++ b/services/named-groups/v1/operations/get-itwin-groups/description.md @@ -0,0 +1,22 @@ +--- + +Gets all groups of an iTwin. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!GroupQuery.md!} + +{!Authorization.md!} + +{!NamedGroupsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/named-groups/v1/operations/get-itwin-groups/displayName.md b/services/named-groups/v1/operations/get-itwin-groups/displayName.md new file mode 100644 index 0000000..56a219e --- /dev/null +++ b/services/named-groups/v1/operations/get-itwin-groups/displayName.md @@ -0,0 +1 @@ +Get iTwin Groups \ No newline at end of file diff --git a/services/named-groups/v1/operations/update-group/description.md b/services/named-groups/v1/operations/update-group/description.md new file mode 100644 index 0000000..c4c52fd --- /dev/null +++ b/services/named-groups/v1/operations/update-group/description.md @@ -0,0 +1,13 @@ +--- + +Updates a group. + +{!GroupQuery.md!} + +{!Authorization.md!} + +{!NamedGroupsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/named-groups/v1/operations/update-group/displayName.md b/services/named-groups/v1/operations/update-group/displayName.md new file mode 100644 index 0000000..2c798a5 --- /dev/null +++ b/services/named-groups/v1/operations/update-group/displayName.md @@ -0,0 +1 @@ +Update Group \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/description.md b/services/pnid-to-itwin/v2/description.md new file mode 100644 index 0000000..53ed143 --- /dev/null +++ b/services/pnid-to-itwin/v2/description.md @@ -0,0 +1 @@ +Recognize symbols and tags from a raster PnID. \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/create-inference-run/description.md b/services/pnid-to-itwin/v2/operations/create-inference-run/description.md new file mode 100644 index 0000000..3d9bb22 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/create-inference-run/description.md @@ -0,0 +1,7 @@ +--- + +Starts PnID Inference Run after all inputs are uploaded. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/create-inference-run/displayName.md b/services/pnid-to-itwin/v2/operations/create-inference-run/displayName.md new file mode 100644 index 0000000..5f9bc35 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/create-inference-run/displayName.md @@ -0,0 +1 @@ +Create Inference Run \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/create-inference/description.md b/services/pnid-to-itwin/v2/operations/create-inference/description.md new file mode 100644 index 0000000..56e327b --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/create-inference/description.md @@ -0,0 +1,6 @@ +--- +Creates new PnID Inference for a specific model version. This endpoint registers a new inference pipeline in Azure Machine Learning service with already trained PnID (Piping & Instrumentation Diagrams) ML model. To create new PnID Inference please provide iTwin ID and model version. All available model versions are listed in the [Model versions](/apis/pnid-to-itwin-v2/model-versions/) section. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/create-inference/displayName.md b/services/pnid-to-itwin/v2/operations/create-inference/displayName.md new file mode 100644 index 0000000..dffe267 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/create-inference/displayName.md @@ -0,0 +1 @@ +Create Inference \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/delete-inference-input/description.md b/services/pnid-to-itwin/v2/operations/delete-inference-input/description.md new file mode 100644 index 0000000..63d6b52 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/delete-inference-input/description.md @@ -0,0 +1,7 @@ +--- + +Deletes PnID Inference Input. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/delete-inference-input/displayName.md b/services/pnid-to-itwin/v2/operations/delete-inference-input/displayName.md new file mode 100644 index 0000000..f551820 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/delete-inference-input/displayName.md @@ -0,0 +1 @@ +Delete Inference Input \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/delete-inference-run/description.md b/services/pnid-to-itwin/v2/operations/delete-inference-run/description.md new file mode 100644 index 0000000..7dfbdce --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/delete-inference-run/description.md @@ -0,0 +1,7 @@ +--- + +Cancels execution of PnID Inference Run. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/delete-inference-run/displayName.md b/services/pnid-to-itwin/v2/operations/delete-inference-run/displayName.md new file mode 100644 index 0000000..0b680a3 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/delete-inference-run/displayName.md @@ -0,0 +1 @@ +Delete Inference Run \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/delete-inference/description.md b/services/pnid-to-itwin/v2/operations/delete-inference/description.md new file mode 100644 index 0000000..0747ac0 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/delete-inference/description.md @@ -0,0 +1,7 @@ +--- + +Deletes PnID Inference. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/delete-inference/displayName.md b/services/pnid-to-itwin/v2/operations/delete-inference/displayName.md new file mode 100644 index 0000000..88e46b4 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/delete-inference/displayName.md @@ -0,0 +1 @@ +Delete Inference \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/get-inference-input-content/description.md b/services/pnid-to-itwin/v2/operations/get-inference-input-content/description.md new file mode 100644 index 0000000..9140107 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference-input-content/description.md @@ -0,0 +1,7 @@ +--- + +Returns content of PnID Inference Input. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/get-inference-input-content/displayName.md b/services/pnid-to-itwin/v2/operations/get-inference-input-content/displayName.md new file mode 100644 index 0000000..1ac2f4f --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference-input-content/displayName.md @@ -0,0 +1 @@ +Get Inference Input Content \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/get-inference-inputs/description.md b/services/pnid-to-itwin/v2/operations/get-inference-inputs/description.md new file mode 100644 index 0000000..a7187bf --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference-inputs/description.md @@ -0,0 +1,7 @@ +--- + +Returns all PnID Inference Inputs. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/get-inference-inputs/displayName.md b/services/pnid-to-itwin/v2/operations/get-inference-inputs/displayName.md new file mode 100644 index 0000000..335a589 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference-inputs/displayName.md @@ -0,0 +1 @@ +Get Inference Inputs \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run-result-content/description.md b/services/pnid-to-itwin/v2/operations/get-inference-run-result-content/description.md new file mode 100644 index 0000000..ce6b236 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference-run-result-content/description.md @@ -0,0 +1,7 @@ +--- + +Returns content of PnID Inference Run Result. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run-result-content/displayName.md b/services/pnid-to-itwin/v2/operations/get-inference-run-result-content/displayName.md new file mode 100644 index 0000000..dd2e5a4 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference-run-result-content/displayName.md @@ -0,0 +1 @@ +Get Inference Run Result Content \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run-results/description.md b/services/pnid-to-itwin/v2/operations/get-inference-run-results/description.md new file mode 100644 index 0000000..acc78e9 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference-run-results/description.md @@ -0,0 +1,7 @@ +--- + +Returns all PnID Inference Results. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run-results/displayName.md b/services/pnid-to-itwin/v2/operations/get-inference-run-results/displayName.md new file mode 100644 index 0000000..1833c39 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference-run-results/displayName.md @@ -0,0 +1 @@ +Get Inference Run Results \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run/description.md b/services/pnid-to-itwin/v2/operations/get-inference-run/description.md new file mode 100644 index 0000000..1513257 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference-run/description.md @@ -0,0 +1,7 @@ +--- + +Returns status of PnID Inference Run. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run/displayName.md b/services/pnid-to-itwin/v2/operations/get-inference-run/displayName.md new file mode 100644 index 0000000..2a653aa --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference-run/displayName.md @@ -0,0 +1 @@ +Get Inference Run Status \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/get-inference/description.md b/services/pnid-to-itwin/v2/operations/get-inference/description.md new file mode 100644 index 0000000..569eac8 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference/description.md @@ -0,0 +1,7 @@ +--- + +Gets PnID Inference by specified id. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/get-inference/displayName.md b/services/pnid-to-itwin/v2/operations/get-inference/displayName.md new file mode 100644 index 0000000..4bee154 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-inference/displayName.md @@ -0,0 +1 @@ +Get Inference \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/get-itwin-inferences/description.md b/services/pnid-to-itwin/v2/operations/get-itwin-inferences/description.md new file mode 100644 index 0000000..3877d4e --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-itwin-inferences/description.md @@ -0,0 +1,7 @@ +--- + +Returns all PnID Inferences in iTwin. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/get-itwin-inferences/displayName.md b/services/pnid-to-itwin/v2/operations/get-itwin-inferences/displayName.md new file mode 100644 index 0000000..14f2090 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/get-itwin-inferences/displayName.md @@ -0,0 +1 @@ +Get iTwin Inferences \ No newline at end of file diff --git a/services/pnid-to-itwin/v2/operations/upload-inference-input-content/description.md b/services/pnid-to-itwin/v2/operations/upload-inference-input-content/description.md new file mode 100644 index 0000000..8c3bc2d --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/upload-inference-input-content/description.md @@ -0,0 +1,7 @@ +--- + +Uploads a file or replace the existing file if one already exists with the same name as PnID Inference Input. + +{!Authorization.md!} + +--- diff --git a/services/pnid-to-itwin/v2/operations/upload-inference-input-content/displayName.md b/services/pnid-to-itwin/v2/operations/upload-inference-input-content/displayName.md new file mode 100644 index 0000000..cf6d818 --- /dev/null +++ b/services/pnid-to-itwin/v2/operations/upload-inference-input-content/displayName.md @@ -0,0 +1 @@ +Upload Inference Input Content \ No newline at end of file diff --git a/services/projects/v1/description.md b/services/projects/v1/description.md new file mode 100644 index 0000000..19a072b --- /dev/null +++ b/services/projects/v1/description.md @@ -0,0 +1,3 @@ +Interact with your projects. + +View, update, create, and delete projects. diff --git a/services/projects/v1/operations/add-project-team-member/description.md b/services/projects/v1/operations/add-project-team-member/description.md new file mode 100644 index 0000000..4a922fc --- /dev/null +++ b/services/projects/v1/operations/add-project-team-member/description.md @@ -0,0 +1,21 @@ +--- + +Add new project team member + +### Notes + +The POST body MUST include either a *userId* property or an *e-mail* property. + +When adding members by ids, the POST body MAY include the roleIds property, which MUST be defined as an array of role IDs that will be assigned to new team member. + +When adding members by names, the POST body MAY include the roleNames property, which MUST be defined as an array of role names that will be assigned to new team member. + +When adding members *Team Member* role will be assigned to all members. *Team Member* role grants member write access to Storage and Forms APIs. *Team Member* can be removed from any member if access to Storage and Forms APIs is not desired. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/projects/v1/operations/add-project-team-member/displayName.md b/services/projects/v1/operations/add-project-team-member/displayName.md new file mode 100644 index 0000000..239e839 --- /dev/null +++ b/services/projects/v1/operations/add-project-team-member/displayName.md @@ -0,0 +1 @@ +Add project team member \ No newline at end of file diff --git a/services/projects/v1/operations/add-project-to-my-favorites/description.md b/services/projects/v1/operations/add-project-to-my-favorites/description.md new file mode 100644 index 0000000..2c3af20 --- /dev/null +++ b/services/projects/v1/operations/add-project-to-my-favorites/description.md @@ -0,0 +1,9 @@ +--- + +Add a project to my favorites list. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +--- diff --git a/services/projects/v1/operations/add-project-to-my-favorites/displayName.md b/services/projects/v1/operations/add-project-to-my-favorites/displayName.md new file mode 100644 index 0000000..45bfea9 --- /dev/null +++ b/services/projects/v1/operations/add-project-to-my-favorites/displayName.md @@ -0,0 +1 @@ +Add project to my favorites \ No newline at end of file diff --git a/services/projects/v1/operations/add-project-to-my-recents/description.md b/services/projects/v1/operations/add-project-to-my-recents/description.md new file mode 100644 index 0000000..bf5c49b --- /dev/null +++ b/services/projects/v1/operations/add-project-to-my-recents/description.md @@ -0,0 +1,9 @@ +--- + +Adds a project to my recently used projects list. No more than 25 projects are stored in the recently used list. Older ones are removed to make room for new ones. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/projects/v1/operations/add-project-to-my-recents/displayName.md b/services/projects/v1/operations/add-project-to-my-recents/displayName.md new file mode 100644 index 0000000..e7476d8 --- /dev/null +++ b/services/projects/v1/operations/add-project-to-my-recents/displayName.md @@ -0,0 +1 @@ +Add project to my recents \ No newline at end of file diff --git a/services/projects/v1/operations/create-project-role/description.md b/services/projects/v1/operations/create-project-role/description.md new file mode 100644 index 0000000..d8ff4d8 --- /dev/null +++ b/services/projects/v1/operations/create-project-role/description.md @@ -0,0 +1,15 @@ +--- + +Create new project role. + +### Notes + +- The POST body MUST include the displayName property. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/projects/v1/operations/create-project-role/displayName.md b/services/projects/v1/operations/create-project-role/displayName.md new file mode 100644 index 0000000..2b60b4c --- /dev/null +++ b/services/projects/v1/operations/create-project-role/displayName.md @@ -0,0 +1 @@ +Create project role \ No newline at end of file diff --git a/services/projects/v1/operations/create-project/description.md b/services/projects/v1/operations/create-project/description.md new file mode 100644 index 0000000..e89141f --- /dev/null +++ b/services/projects/v1/operations/create-project/description.md @@ -0,0 +1,18 @@ +--- + +Create a new project + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +### Authorization +If a user is affiliated with an Organization, then the user must be an Organization Administrator in order to create a project. The new project will be owned by the Organization. +Example: john.doe@example.com is an Organization Administrator that works for Example Industries that has an account with Bentley. John will be able to create projects and those projects will belong to Example Industries. John and any other Organization Administrator for Example Industries will be able to update or delete the project. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +Any user that is not affiliated with an Organization can create a project. The new project will be owned by the user account. +Example: jane.doe@gmail.com is an independent contractor that does not have an account with Bentley. Jane will be able to create projects and those projects will belong to Jane. Only Jane will be able to update or delete the project. + +--- diff --git a/services/projects/v1/operations/create-project/displayName.md b/services/projects/v1/operations/create-project/displayName.md new file mode 100644 index 0000000..40e0a51 --- /dev/null +++ b/services/projects/v1/operations/create-project/displayName.md @@ -0,0 +1 @@ +Create project \ No newline at end of file diff --git a/services/projects/v1/operations/delete-project-role/description.md b/services/projects/v1/operations/delete-project-role/description.md new file mode 100644 index 0000000..fdebe2f --- /dev/null +++ b/services/projects/v1/operations/delete-project-role/description.md @@ -0,0 +1,11 @@ +--- + +Delete the specified project role. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/projects/v1/operations/delete-project-role/displayName.md b/services/projects/v1/operations/delete-project-role/displayName.md new file mode 100644 index 0000000..c98d279 --- /dev/null +++ b/services/projects/v1/operations/delete-project-role/displayName.md @@ -0,0 +1 @@ +Delete project role \ No newline at end of file diff --git a/services/projects/v1/operations/delete-project/description.md b/services/projects/v1/operations/delete-project/description.md new file mode 100644 index 0000000..ad5612c --- /dev/null +++ b/services/projects/v1/operations/delete-project/description.md @@ -0,0 +1,18 @@ +--- + +Delete the specified project. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +### Authorization +If a user is affiliated with an Organization, then the user must be an Organization Administrator in order to delete a project that is owned by the Organization. +Example: john.doe@example.com is an Organization Administrator that works for Example Industries that has an account with Bentley. John will be able to delete any project that belongs to Example Industries. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +A user that is not affiliated with an Organization can delete projects that are owned by the user account. +Example: jane.doe@gmail.com is an independent contractor that does not have an account with Bentley. Jane will be able to delete any project that belongs to Jane. Jane owns any project that she created. + +--- diff --git a/services/projects/v1/operations/delete-project/displayName.md b/services/projects/v1/operations/delete-project/displayName.md new file mode 100644 index 0000000..6ae85bb --- /dev/null +++ b/services/projects/v1/operations/delete-project/displayName.md @@ -0,0 +1 @@ +Delete project \ No newline at end of file diff --git a/services/projects/v1/operations/get-my-favorite-projects/description.md b/services/projects/v1/operations/get-my-favorite-projects/description.md new file mode 100644 index 0000000..73e918c --- /dev/null +++ b/services/projects/v1/operations/get-my-favorite-projects/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves a list of favorite projects for the logged in user. The user is determined by the authentication token. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +### Response + +By default, each project in the returned list of projects will have only the project id, display name and project number. + +A full representation of each project can be returned by specifying the *prefer* header that includes a value of *return=representation*. + +--- diff --git a/services/projects/v1/operations/get-my-favorite-projects/displayName.md b/services/projects/v1/operations/get-my-favorite-projects/displayName.md new file mode 100644 index 0000000..3e5dc11 --- /dev/null +++ b/services/projects/v1/operations/get-my-favorite-projects/displayName.md @@ -0,0 +1 @@ +Get my favorite projects \ No newline at end of file diff --git a/services/projects/v1/operations/get-my-recently-used-projects/description.md b/services/projects/v1/operations/get-my-recently-used-projects/description.md new file mode 100644 index 0000000..93d2c89 --- /dev/null +++ b/services/projects/v1/operations/get-my-recently-used-projects/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves a list of recently used projects for the logged in user. The user is determined by the authentication token. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +### Response + +By default, each project in the returned list of projects will have only the project id, display name and project number. + +A full representation of each project can be returned by specifying the *prefer* header that includes a value of *return=representation*. + +--- diff --git a/services/projects/v1/operations/get-my-recently-used-projects/displayName.md b/services/projects/v1/operations/get-my-recently-used-projects/displayName.md new file mode 100644 index 0000000..cc60dfb --- /dev/null +++ b/services/projects/v1/operations/get-my-recently-used-projects/displayName.md @@ -0,0 +1 @@ +Get my recently used projects \ No newline at end of file diff --git a/services/projects/v1/operations/get-project-roles/description.md b/services/projects/v1/operations/get-project-roles/description.md new file mode 100644 index 0000000..173fcd9 --- /dev/null +++ b/services/projects/v1/operations/get-project-roles/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves a list of available user roles that are defined for a specified project. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/projects/v1/operations/get-project-roles/displayName.md b/services/projects/v1/operations/get-project-roles/displayName.md new file mode 100644 index 0000000..8e1df42 --- /dev/null +++ b/services/projects/v1/operations/get-project-roles/displayName.md @@ -0,0 +1 @@ +Get project roles \ No newline at end of file diff --git a/services/projects/v1/operations/get-project-team-member-details/description.md b/services/projects/v1/operations/get-project-team-member-details/description.md new file mode 100644 index 0000000..4fba61d --- /dev/null +++ b/services/projects/v1/operations/get-project-team-member-details/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves detailed information of specific team member for a specified project. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +### Authorization + +User must be an Organization Administrator for the Organization that owns a given project or be a project team member. + +{!OrganizationAdministrator.md!} + +--- \ No newline at end of file diff --git a/services/projects/v1/operations/get-project-team-member-details/displayName.md b/services/projects/v1/operations/get-project-team-member-details/displayName.md new file mode 100644 index 0000000..fc9954a --- /dev/null +++ b/services/projects/v1/operations/get-project-team-member-details/displayName.md @@ -0,0 +1 @@ +Get project team member details \ No newline at end of file diff --git a/services/projects/v1/operations/get-project-team-members/description.md b/services/projects/v1/operations/get-project-team-members/description.md new file mode 100644 index 0000000..d04d38b --- /dev/null +++ b/services/projects/v1/operations/get-project-team-members/description.md @@ -0,0 +1,22 @@ +--- + +Retrieves a list of team members and their roles assigned to a specified project. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +### Authorization + +User must be an Organization Administrator for the Organization that owns a given project or be a project team member. + +{!OrganizationAdministrator.md!} + +### Response + +By default, each member in the returned list of members will only have names of the roles that are assigned to the user. + +A full representation of roles assigned to the member can be returned by specifying the *prefer* header that includes a value of *return=representation*. + + +--- \ No newline at end of file diff --git a/services/projects/v1/operations/get-project-team-members/displayName.md b/services/projects/v1/operations/get-project-team-members/displayName.md new file mode 100644 index 0000000..8ae2d92 --- /dev/null +++ b/services/projects/v1/operations/get-project-team-members/displayName.md @@ -0,0 +1 @@ +Get project team members \ No newline at end of file diff --git a/services/projects/v1/operations/get-project/description.md b/services/projects/v1/operations/get-project/description.md new file mode 100644 index 0000000..ec9b8d2 --- /dev/null +++ b/services/projects/v1/operations/get-project/description.md @@ -0,0 +1,15 @@ +--- + +Gets the details of the specified project. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +### Authorization + +User must be an Organization Administrator for the Organization that owns the specified project or be a project team member. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +--- diff --git a/services/projects/v1/operations/get-project/displayName.md b/services/projects/v1/operations/get-project/displayName.md new file mode 100644 index 0000000..43e1ee5 --- /dev/null +++ b/services/projects/v1/operations/get-project/displayName.md @@ -0,0 +1 @@ +Get project \ No newline at end of file diff --git a/services/projects/v1/operations/get-user-permissions/description.md b/services/projects/v1/operations/get-user-permissions/description.md new file mode 100644 index 0000000..f67eb80 --- /dev/null +++ b/services/projects/v1/operations/get-user-permissions/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves a list of permissions the user has for a specified project. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/projects/v1/operations/get-user-permissions/displayName.md b/services/projects/v1/operations/get-user-permissions/displayName.md new file mode 100644 index 0000000..106237c --- /dev/null +++ b/services/projects/v1/operations/get-user-permissions/displayName.md @@ -0,0 +1 @@ +Get member permissions \ No newline at end of file diff --git a/services/projects/v1/operations/my-projects/description.md b/services/projects/v1/operations/my-projects/description.md new file mode 100644 index 0000000..f398efe --- /dev/null +++ b/services/projects/v1/operations/my-projects/description.md @@ -0,0 +1,21 @@ +--- + +Retrieves a list of projects that can be accessed by the logged in user. The user is determined by the authentication token. See the Authorization section for information on how access rights are determined. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +### Authorization + +User must be an Organization Administrator for the Organization that owns a given project or be a project team member. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +### Response + +By default, each project in the returned list of projects will have only the project id, display name and project number. + +A full representation of each project can be returned by specifying the *prefer* header that includes a value of *return=representation*. + +--- diff --git a/services/projects/v1/operations/my-projects/displayName.md b/services/projects/v1/operations/my-projects/displayName.md new file mode 100644 index 0000000..26c53aa --- /dev/null +++ b/services/projects/v1/operations/my-projects/displayName.md @@ -0,0 +1 @@ +Get my projects \ No newline at end of file diff --git a/services/projects/v1/operations/remove-project-from-my-favorites/description.md b/services/projects/v1/operations/remove-project-from-my-favorites/description.md new file mode 100644 index 0000000..72d1aea --- /dev/null +++ b/services/projects/v1/operations/remove-project-from-my-favorites/description.md @@ -0,0 +1,7 @@ +--- + +Remove a project to my favorites list. + +{!Authorization.md!} + +--- diff --git a/services/projects/v1/operations/remove-project-from-my-favorites/displayName.md b/services/projects/v1/operations/remove-project-from-my-favorites/displayName.md new file mode 100644 index 0000000..b5667d2 --- /dev/null +++ b/services/projects/v1/operations/remove-project-from-my-favorites/displayName.md @@ -0,0 +1 @@ +Remove project from my favorites \ No newline at end of file diff --git a/services/projects/v1/operations/remove-project-team-member/description.md b/services/projects/v1/operations/remove-project-team-member/description.md new file mode 100644 index 0000000..0439539 --- /dev/null +++ b/services/projects/v1/operations/remove-project-team-member/description.md @@ -0,0 +1,9 @@ +--- + +Remove the specified project team member. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/projects/v1/operations/remove-project-team-member/displayName.md b/services/projects/v1/operations/remove-project-team-member/displayName.md new file mode 100644 index 0000000..003f1b1 --- /dev/null +++ b/services/projects/v1/operations/remove-project-team-member/displayName.md @@ -0,0 +1 @@ +Remove project team member \ No newline at end of file diff --git a/services/projects/v1/operations/update-project-role/description.md b/services/projects/v1/operations/update-project-role/description.md new file mode 100644 index 0000000..22a4f45 --- /dev/null +++ b/services/projects/v1/operations/update-project-role/description.md @@ -0,0 +1,16 @@ +--- + +Update the specified project role. + +### Notes + +To assign permissions to a role PATCH body MUST include an array of permissions. If a user is not Organization Administrator permissions that could be assigned to the role +are limited to permissions the user has on a project. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/projects/v1/operations/update-project-role/displayName.md b/services/projects/v1/operations/update-project-role/displayName.md new file mode 100644 index 0000000..88d8c05 --- /dev/null +++ b/services/projects/v1/operations/update-project-role/displayName.md @@ -0,0 +1 @@ +Update project role \ No newline at end of file diff --git a/services/projects/v1/operations/update-project-team-member-roles/description.md b/services/projects/v1/operations/update-project-team-member-roles/description.md new file mode 100644 index 0000000..63f392a --- /dev/null +++ b/services/projects/v1/operations/update-project-team-member-roles/description.md @@ -0,0 +1,15 @@ +--- + +Update project team member roles + +### Notes + +The PATCH body MUST include the roleIds property, which MUST be defined as an array of role IDs that will be assigned to new team member. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/projects/v1/operations/update-project-team-member-roles/displayName.md b/services/projects/v1/operations/update-project-team-member-roles/displayName.md new file mode 100644 index 0000000..b903d3d --- /dev/null +++ b/services/projects/v1/operations/update-project-team-member-roles/displayName.md @@ -0,0 +1 @@ +Update project team member roles \ No newline at end of file diff --git a/services/projects/v1/operations/update-project/description.md b/services/projects/v1/operations/update-project/description.md new file mode 100644 index 0000000..2d8aa4c --- /dev/null +++ b/services/projects/v1/operations/update-project/description.md @@ -0,0 +1,20 @@ +--- + +Update the specified project. + +For updates, all properties are optional. The request payload only needs to contain the properties that you would like to update. + +{!ProjectsDeprecated.md!} + +{!Authorization.md!} + +### Authorization +If a user is affiliated with an Organization, then the user must be an Organization Administrator in order to update a project that is owned by the Organization. +Example: john.doe@example.com is an Organization Administrator that works for Example Industries that has an account with Bentley. John will be able to update any project that belongs to Example Industries. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +A user that is not affiliated with an Organization can update projects that are owned by the user account. +Example: jane.doe@gmail.com is an independent contractor that does not have an account with Bentley. Jane will be able to update any project that belong to Jane. Jane owns any project that she created. + +--- diff --git a/services/projects/v1/operations/update-project/displayName.md b/services/projects/v1/operations/update-project/displayName.md new file mode 100644 index 0000000..edb5bd6 --- /dev/null +++ b/services/projects/v1/operations/update-project/displayName.md @@ -0,0 +1 @@ +Update project \ No newline at end of file diff --git a/services/projectwise365-insights/v1/description.md b/services/projectwise365-insights/v1/description.md new file mode 100644 index 0000000..7ed533f --- /dev/null +++ b/services/projectwise365-insights/v1/description.md @@ -0,0 +1,3 @@ +Access insights into your projects and models. + +View insights derived from your projects and models sourced from the Project Insights and Design Insights services. diff --git a/services/projectwise365-insights/v1/operations/project-metadata/description.md b/services/projectwise365-insights/v1/operations/project-metadata/description.md new file mode 100644 index 0000000..62b04c6 --- /dev/null +++ b/services/projectwise365-insights/v1/operations/project-metadata/description.md @@ -0,0 +1,15 @@ +--- + +### What is this API? +This API retrieves Project Insights OData feed metadata. +A configured Project in Project Insights is required. + +### What is Project Insights? +ProjectWise Project Insights automates your reporting of design project performance, enabling more informed and proactive decision making with regular access to analytics and trends. [Learn more](https://www.bentley.com/en/products/product-line/project-delivery-software/projectwise-project-insights) + +### Power BI Connector +Find an example Power BI connector in the [Bentley Communities](https://communities.bentley.com/products/projectwise/content_management/w/wiki/41259/projectwise-project-insights). + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/projectwise365-insights/v1/operations/project-metadata/displayName.md b/services/projectwise365-insights/v1/operations/project-metadata/displayName.md new file mode 100644 index 0000000..c526936 --- /dev/null +++ b/services/projectwise365-insights/v1/operations/project-metadata/displayName.md @@ -0,0 +1 @@ +Project $metadata \ No newline at end of file diff --git a/services/projectwise365-insights/v1/operations/project-odata/description.md b/services/projectwise365-insights/v1/operations/project-odata/description.md new file mode 100644 index 0000000..1e8a295 --- /dev/null +++ b/services/projectwise365-insights/v1/operations/project-odata/description.md @@ -0,0 +1,15 @@ +--- + +### What is this API? +This API retrieves Project Insights OData entries from a given table needed to construct dashboards. +A configured Project in Project Insights is required. + +### What is Project Insights? +ProjectWise Project Insights automates your reporting of design project performance, enabling more informed and proactive decision making with regular access to analytics and trends. [Learn more](https://www.bentley.com/en/products/product-line/project-delivery-software/projectwise-project-insights) + +### Power BI Connector +Find an example Power BI connector in the [Bentley Communities](https://communities.bentley.com/products/projectwise/content_management/w/wiki/41259/projectwise-project-insights). + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/projectwise365-insights/v1/operations/project-odata/displayName.md b/services/projectwise365-insights/v1/operations/project-odata/displayName.md new file mode 100644 index 0000000..d9413aa --- /dev/null +++ b/services/projectwise365-insights/v1/operations/project-odata/displayName.md @@ -0,0 +1 @@ +Project OData \ No newline at end of file diff --git a/services/projectwise365-insights/v1/operations/project-schema/description.md b/services/projectwise365-insights/v1/operations/project-schema/description.md new file mode 100644 index 0000000..f11a153 --- /dev/null +++ b/services/projectwise365-insights/v1/operations/project-schema/description.md @@ -0,0 +1,15 @@ +--- + +### What is this API? +This API retrieves Project Insights OData feed schema. +A configured Project in Project Insights is required. + +### What is Project Insights? +ProjectWise Project Insights automates your reporting of design project performance, enabling more informed and proactive decision making with regular access to analytics and trends. [Learn more](https://www.bentley.com/en/products/product-line/project-delivery-software/projectwise-project-insights) + +### Power BI Connector +Find an example Power BI connector in the [Bentley Communities](https://communities.bentley.com/products/projectwise/content_management/w/wiki/41259/projectwise-project-insights). + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/projectwise365-insights/v1/operations/project-schema/displayName.md b/services/projectwise365-insights/v1/operations/project-schema/displayName.md new file mode 100644 index 0000000..8dffbe5 --- /dev/null +++ b/services/projectwise365-insights/v1/operations/project-schema/displayName.md @@ -0,0 +1 @@ +Project Schema \ No newline at end of file diff --git a/services/reality-data/v1/description.md b/services/reality-data/v1/description.md new file mode 100644 index 0000000..b61a97b --- /dev/null +++ b/services/reality-data/v1/description.md @@ -0,0 +1,3 @@ +Interact with your reality data. + +View, update, create, and delete reality data. diff --git a/services/reality-data/v1/operations/associate-to-project/description.md b/services/reality-data/v1/operations/associate-to-project/description.md new file mode 100644 index 0000000..539e45c --- /dev/null +++ b/services/reality-data/v1/operations/associate-to-project/description.md @@ -0,0 +1,11 @@ +--- + +Associates a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) to a project. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-data/v1/operations/associate-to-project/displayName.md b/services/reality-data/v1/operations/associate-to-project/displayName.md new file mode 100644 index 0000000..28adbce --- /dev/null +++ b/services/reality-data/v1/operations/associate-to-project/displayName.md @@ -0,0 +1 @@ +Associate a reality data to a project \ No newline at end of file diff --git a/services/reality-data/v1/operations/create-reality-data/description.md b/services/reality-data/v1/operations/create-reality-data/description.md new file mode 100644 index 0000000..b3989f9 --- /dev/null +++ b/services/reality-data/v1/operations/create-reality-data/description.md @@ -0,0 +1,21 @@ +--- + +Creates a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +As shown in the request section below, you must provide a request body. + +You MUST provide the `displayName`, `classification` and `type` properties. + +Valid values for the `classification` property are: `Terrain`, `Imagery`, `Pinned`, `Model`, `Undefined`. For more details on each value, see [Reality Data Properties](https://developer.bentley.com/apis/reality-data/rd-details/) in documentation. + +We recommend specifying a `projectId` in the request body, as it is used to choose the data center where the reality data is stored (the same as the project). If no `projectId` can be provided, the default data center of the organization is selected. + +After creation, the reality data will be associated to the specified project. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-data/v1/operations/create-reality-data/displayName.md b/services/reality-data/v1/operations/create-reality-data/displayName.md new file mode 100644 index 0000000..0c3a0fe --- /dev/null +++ b/services/reality-data/v1/operations/create-reality-data/displayName.md @@ -0,0 +1 @@ +Create reality data \ No newline at end of file diff --git a/services/reality-data/v1/operations/delete-reality-data/description.md b/services/reality-data/v1/operations/delete-reality-data/description.md new file mode 100644 index 0000000..177f1d1 --- /dev/null +++ b/services/reality-data/v1/operations/delete-reality-data/description.md @@ -0,0 +1,13 @@ +--- + +Deletes a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +To delete a reality data, it must be associated to only one (or zero) project. If it has more associated projects, first [dissociate](https://developer.bentley.com/apis/reality-data/operations/dissociate-from-project/) the projects. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-data/v1/operations/delete-reality-data/displayName.md b/services/reality-data/v1/operations/delete-reality-data/displayName.md new file mode 100644 index 0000000..8fa1693 --- /dev/null +++ b/services/reality-data/v1/operations/delete-reality-data/displayName.md @@ -0,0 +1 @@ +Delete reality data \ No newline at end of file diff --git a/services/reality-data/v1/operations/dissociate-from-project/description.md b/services/reality-data/v1/operations/dissociate-from-project/description.md new file mode 100644 index 0000000..bad687b --- /dev/null +++ b/services/reality-data/v1/operations/dissociate-from-project/description.md @@ -0,0 +1,11 @@ +--- + +Dissociates a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) from a project. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-data/v1/operations/dissociate-from-project/displayName.md b/services/reality-data/v1/operations/dissociate-from-project/displayName.md new file mode 100644 index 0000000..b7c0b92 --- /dev/null +++ b/services/reality-data/v1/operations/dissociate-from-project/displayName.md @@ -0,0 +1 @@ +Dissociate a reality data from a project \ No newline at end of file diff --git a/services/reality-data/v1/operations/get-all-reality-data/description.md b/services/reality-data/v1/operations/get-all-reality-data/description.md new file mode 100644 index 0000000..01650fc --- /dev/null +++ b/services/reality-data/v1/operations/get-all-reality-data/description.md @@ -0,0 +1,29 @@ +--- + +Retrieves a list of [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) instances belonging to the specified project. + +The retrieved instances are those for which you have the required access rights, relative to the specified project. + +The `projectId` is optional. If you don't provide it, the retrieved [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) instances will be relative to general access rights provided by your organization. These rights are usually more restrictive, so we recommend using the `projectId` parameter for exhaustive results. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request, i.e., all properties are included in the response. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +### Authorization + +User must be an Organization Administrator for the Organization that owns a given Project or must have access to context. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page. + + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-data/v1/operations/get-all-reality-data/displayName.md b/services/reality-data/v1/operations/get-all-reality-data/displayName.md new file mode 100644 index 0000000..fac931d --- /dev/null +++ b/services/reality-data/v1/operations/get-all-reality-data/displayName.md @@ -0,0 +1 @@ +Get project's reality data \ No newline at end of file diff --git a/services/reality-data/v1/operations/get-reality-data-container/description.md b/services/reality-data/v1/operations/get-reality-data-container/description.md new file mode 100644 index 0000000..dd906ab --- /dev/null +++ b/services/reality-data/v1/operations/get-reality-data-container/description.md @@ -0,0 +1,27 @@ +--- + +Retrieves the container's link for an instance of [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +A container is where the reality data itself (a point cloud, a mesh, a collection of images, ...) is stored. + +The container's link will allow you to upload/download data directly to this container. + +A [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) is always associated to exactly one container. + +The `projectId` parameter is optional, but it is preferable to provide it, because the permissions used to access the container are determined from the project. With no project specified, the operation can succeed in some cases (e.g. the user is the reality data's owner), but we recommend to provide a `projectId`. + +In future API versions, containers could be hosted in in different cloud providers, but for now, only Azure cloud is supported. + +To store or retrieve data from a container, refer to the [Azure Blob Storage documentation](https://docs.microsoft.com/en-us/azure/storage/blobs/). + +{!Authorization.md!} + +### Authorization + +User must be an Organization Administrator for the Organization that owns a given Project or have `RDS_USE` permission for read access and `RDS_MANAGE` permission for write access assigned at the Project level. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page. + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-data/v1/operations/get-reality-data-container/displayName.md b/services/reality-data/v1/operations/get-reality-data-container/displayName.md new file mode 100644 index 0000000..b95e648 --- /dev/null +++ b/services/reality-data/v1/operations/get-reality-data-container/displayName.md @@ -0,0 +1 @@ +Get the reality data's container \ No newline at end of file diff --git a/services/reality-data/v1/operations/get-reality-data-details/description.md b/services/reality-data/v1/operations/get-reality-data-details/description.md new file mode 100644 index 0000000..8f76624 --- /dev/null +++ b/services/reality-data/v1/operations/get-reality-data-details/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves the metadata of a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +The `projectId` parameter is optional, but it is preferable to provide it, because the permissions used to access the collection of reality data are determined from the project. With no project specified, the desired reality data can be retrieved (e.g. the caller is the owner), but it's more likely to get the expected result if you provide the `projectId`. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-data/v1/operations/get-reality-data-details/displayName.md b/services/reality-data/v1/operations/get-reality-data-details/displayName.md new file mode 100644 index 0000000..4ee1a4c --- /dev/null +++ b/services/reality-data/v1/operations/get-reality-data-details/displayName.md @@ -0,0 +1 @@ +Get reality data metadata \ No newline at end of file diff --git a/services/reality-data/v1/operations/get-reality-data-projects/description.md b/services/reality-data/v1/operations/get-reality-data-projects/description.md new file mode 100644 index 0000000..dc2f28a --- /dev/null +++ b/services/reality-data/v1/operations/get-reality-data-projects/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves the list of projects associated to the specified [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +When no project is associated to the reality data, an empty list is returned. + +Similarly, if the reality data does not exist, an empty list is returned. No validation is made about the existence or validity of the reality data. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-data/v1/operations/get-reality-data-projects/displayName.md b/services/reality-data/v1/operations/get-reality-data-projects/displayName.md new file mode 100644 index 0000000..55e93cc --- /dev/null +++ b/services/reality-data/v1/operations/get-reality-data-projects/displayName.md @@ -0,0 +1 @@ +Get all projects to which a reality data is associated \ No newline at end of file diff --git a/services/reality-data/v1/operations/update-reality-data/description.md b/services/reality-data/v1/operations/update-reality-data/description.md new file mode 100644 index 0000000..cab6943 --- /dev/null +++ b/services/reality-data/v1/operations/update-reality-data/description.md @@ -0,0 +1,15 @@ +--- + +Updates the metadata of a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +The `projectId` parameter is optional, but it is preferable to provide it, because the permissions used to allow the modification of the reality data are determined from the project. + +With no project specified, it may be possible to modify the reality data (e.g. the caller is the owner), but more permissions may be granted when the `projectId` is provided. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-data/v1/operations/update-reality-data/displayName.md b/services/reality-data/v1/operations/update-reality-data/displayName.md new file mode 100644 index 0000000..5277627 --- /dev/null +++ b/services/reality-data/v1/operations/update-reality-data/displayName.md @@ -0,0 +1 @@ +Update reality data \ No newline at end of file diff --git a/services/reality-management/v1/description.md b/services/reality-management/v1/description.md new file mode 100644 index 0000000..b61a97b --- /dev/null +++ b/services/reality-management/v1/description.md @@ -0,0 +1,3 @@ +Interact with your reality data. + +View, update, create, and delete reality data. diff --git a/services/reality-management/v1/operations/associate-to-iTwin/description.md b/services/reality-management/v1/operations/associate-to-iTwin/description.md new file mode 100644 index 0000000..e0b6008 --- /dev/null +++ b/services/reality-management/v1/operations/associate-to-iTwin/description.md @@ -0,0 +1,11 @@ +--- + +Associates a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) to a iTwin. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-management/v1/operations/associate-to-iTwin/displayName.md b/services/reality-management/v1/operations/associate-to-iTwin/displayName.md new file mode 100644 index 0000000..8e02587 --- /dev/null +++ b/services/reality-management/v1/operations/associate-to-iTwin/displayName.md @@ -0,0 +1 @@ +Associate a reality data to a iTwin \ No newline at end of file diff --git a/services/reality-management/v1/operations/create-reality-data/description.md b/services/reality-management/v1/operations/create-reality-data/description.md new file mode 100644 index 0000000..ac051ea --- /dev/null +++ b/services/reality-management/v1/operations/create-reality-data/description.md @@ -0,0 +1,21 @@ +--- + +Creates a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +As shown in the request section below, you must provide a request body. + +You MUST provide the `displayName` and `type` properties. + +The `rootDocument` property is not required but highly recommended. It is the entry point for consuming applications to read the content of the Reality Data. [See RootDocument property](https://developer.bentley.com/apis/reality-management/rm-rd-details/#root-document) + +For more details on each property, see [Reality Data Properties](https://developer.bentley.com/apis/reality-management/rm-rd-details/) in documentation. + +After creation, the reality data will be associated to the specified iTwin. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-management/v1/operations/create-reality-data/displayName.md b/services/reality-management/v1/operations/create-reality-data/displayName.md new file mode 100644 index 0000000..0c3a0fe --- /dev/null +++ b/services/reality-management/v1/operations/create-reality-data/displayName.md @@ -0,0 +1 @@ +Create reality data \ No newline at end of file diff --git a/services/reality-management/v1/operations/delete-reality-data/description.md b/services/reality-management/v1/operations/delete-reality-data/description.md new file mode 100644 index 0000000..6f84fbc --- /dev/null +++ b/services/reality-management/v1/operations/delete-reality-data/description.md @@ -0,0 +1,13 @@ +--- + +Deletes a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +To delete a reality data, it must be associated to only one (or zero) iTwin. If it has more associated iTwins, first [dissociate](https://developer.bentley.com/apis/reality-management/operations/dissociate-from-itwin/) the iTwins. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-management/v1/operations/delete-reality-data/displayName.md b/services/reality-management/v1/operations/delete-reality-data/displayName.md new file mode 100644 index 0000000..8fa1693 --- /dev/null +++ b/services/reality-management/v1/operations/delete-reality-data/displayName.md @@ -0,0 +1 @@ +Delete reality data \ No newline at end of file diff --git a/services/reality-management/v1/operations/dissociate-from-iTwin/description.md b/services/reality-management/v1/operations/dissociate-from-iTwin/description.md new file mode 100644 index 0000000..8c7557d --- /dev/null +++ b/services/reality-management/v1/operations/dissociate-from-iTwin/description.md @@ -0,0 +1,11 @@ +--- + +Dissociates a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) from a iTwin. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-management/v1/operations/dissociate-from-iTwin/displayName.md b/services/reality-management/v1/operations/dissociate-from-iTwin/displayName.md new file mode 100644 index 0000000..c5f2178 --- /dev/null +++ b/services/reality-management/v1/operations/dissociate-from-iTwin/displayName.md @@ -0,0 +1 @@ +Dissociate a reality data from a iTwin \ No newline at end of file diff --git a/services/reality-management/v1/operations/get-all-reality-data/description.md b/services/reality-management/v1/operations/get-all-reality-data/description.md new file mode 100644 index 0000000..c59dbc1 --- /dev/null +++ b/services/reality-management/v1/operations/get-all-reality-data/description.md @@ -0,0 +1,28 @@ +--- + +Retrieves a list of [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) instances belonging to the specified iTwin. + +The retrieved instances are those for which you have the required access rights, relative to the specified iTwin. + +The `iTwinId` is optional. If you don't provide it, the retrieved [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) instances will be relative to general access rights provided by your organization. These rights are usually more restrictive, so we recommend using the `iTwinId` parameter for exhaustive results. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request, i.e., all properties are included in the response. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +### Authorization + +User must be an Organization Administrator for the Organization that owns a given iTwin or must have access to context. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page. + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-management/v1/operations/get-all-reality-data/displayName.md b/services/reality-management/v1/operations/get-all-reality-data/displayName.md new file mode 100644 index 0000000..126dafb --- /dev/null +++ b/services/reality-management/v1/operations/get-all-reality-data/displayName.md @@ -0,0 +1 @@ +Get iTwin's reality data \ No newline at end of file diff --git a/services/reality-management/v1/operations/get-read-access-to-reality-data-container/description.md b/services/reality-management/v1/operations/get-read-access-to-reality-data-container/description.md new file mode 100644 index 0000000..d948404 --- /dev/null +++ b/services/reality-management/v1/operations/get-read-access-to-reality-data-container/description.md @@ -0,0 +1,26 @@ + +--- +Retrieves the container's link with read access for an instance of [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +A container is where the reality data itself (a point cloud, a mesh, a collection of images, ...) is stored. + +The container's link will allow you to upload/download data directly to this container. + +A [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) is always associated to exactly one container. + +The `iTwinId` parameter is optional, but it is preferable to provide it, because the permissions used to access the container are determined from the iTwin. With no iTwin specified, the operation can succeed in some cases (e.g. the user is the reality data's owner), but we recommend to provide a `iTwinId`. + +In future API versions, containers could be hosted in in different cloud providers, but for now, only Azure cloud is supported. + +To store or retrieve data from a container, refer to the [Azure Blob Storage documentation](https://docs.microsoft.com/en-us/azure/storage/blobs/). + +{!Authorization.md!} + +### Authorization +User must be an Organization Administrator for the Organization that owns a given iTwin or have realitydata_use permission for read access assigned at the iTwin level. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page. + +{!RateLimits.md!} + +--- diff --git a/services/reality-management/v1/operations/get-read-access-to-reality-data-container/displayName.md b/services/reality-management/v1/operations/get-read-access-to-reality-data-container/displayName.md new file mode 100644 index 0000000..cb65356 --- /dev/null +++ b/services/reality-management/v1/operations/get-read-access-to-reality-data-container/displayName.md @@ -0,0 +1 @@ +Retrieve read access to reality data container \ No newline at end of file diff --git a/services/reality-management/v1/operations/get-reality-data-details/description.md b/services/reality-management/v1/operations/get-reality-data-details/description.md new file mode 100644 index 0000000..afe5cc5 --- /dev/null +++ b/services/reality-management/v1/operations/get-reality-data-details/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves the metadata of a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +The `iTwinId` parameter is optional, but it is preferable to provide it, because the permissions used to access the collection of reality data are determined from the iTwin. With no iTwin specified, the desired reality data can be retrieved (e.g. the caller is the owner), but it's more likely to get the expected result if you provide the `iTwinId`. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-management/v1/operations/get-reality-data-details/displayName.md b/services/reality-management/v1/operations/get-reality-data-details/displayName.md new file mode 100644 index 0000000..4ee1a4c --- /dev/null +++ b/services/reality-management/v1/operations/get-reality-data-details/displayName.md @@ -0,0 +1 @@ +Get reality data metadata \ No newline at end of file diff --git a/services/reality-management/v1/operations/get-reality-data-iTwins/description.md b/services/reality-management/v1/operations/get-reality-data-iTwins/description.md new file mode 100644 index 0000000..2a030f4 --- /dev/null +++ b/services/reality-management/v1/operations/get-reality-data-iTwins/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves the list of iTwins associated to the specified [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +When no iTwin is associated to the reality data, an empty list is returned. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-management/v1/operations/get-reality-data-iTwins/displayName.md b/services/reality-management/v1/operations/get-reality-data-iTwins/displayName.md new file mode 100644 index 0000000..21c53e2 --- /dev/null +++ b/services/reality-management/v1/operations/get-reality-data-iTwins/displayName.md @@ -0,0 +1 @@ +Get all iTwins to which a reality data is associated \ No newline at end of file diff --git a/services/reality-management/v1/operations/get-write-access-to-reality-data-container/description.md b/services/reality-management/v1/operations/get-write-access-to-reality-data-container/description.md new file mode 100644 index 0000000..e4b7e5b --- /dev/null +++ b/services/reality-management/v1/operations/get-write-access-to-reality-data-container/description.md @@ -0,0 +1,26 @@ + +--- +Retrieves the container's link with write access for an instance of [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +A container is where the reality data itself (a point cloud, a mesh, a collection of images, ...) is stored. + +The container's link will allow you to upload/download data directly to this container. + +A [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) is always associated to exactly one container. + +The `iTwinId` parameter is optional, but it is preferable to provide it, because the permissions used to access the container are determined from the iTwin. With no iTwin specified, the operation can succeed in some cases (e.g. the user is the reality data's owner), but we recommend to provide a `iTwinId`. + +In future API versions, containers could be hosted in in different cloud providers, but for now, only Azure cloud is supported. + +To store or retrieve data from a container, refer to the [Azure Blob Storage documentation](https://docs.microsoft.com/en-us/azure/storage/blobs/). + +{!Authorization.md!} + +### Authorization +User must be an Organization Administrator for the Organization that owns a given iTwin or have realitydata_manage permission for write access assigned at the iTwin level. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page. + +{!RateLimits.md!} + +--- diff --git a/services/reality-management/v1/operations/get-write-access-to-reality-data-container/displayName.md b/services/reality-management/v1/operations/get-write-access-to-reality-data-container/displayName.md new file mode 100644 index 0000000..32331f7 --- /dev/null +++ b/services/reality-management/v1/operations/get-write-access-to-reality-data-container/displayName.md @@ -0,0 +1 @@ +Retrieve write access to reality data container \ No newline at end of file diff --git a/services/reality-management/v1/operations/update-reality-data/description.md b/services/reality-management/v1/operations/update-reality-data/description.md new file mode 100644 index 0000000..1be660e --- /dev/null +++ b/services/reality-management/v1/operations/update-reality-data/description.md @@ -0,0 +1,15 @@ +--- + +Updates the metadata of a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata). + +The `iTwinId` parameter is optional, but it is preferable to provide it, because the permissions used to allow the modification of the reality data are determined from the iTwin. + +With no iTwin specified, it may be possible to modify the reality data (e.g. the caller is the owner), but more permissions may be granted when the `iTwinId` is provided. + +{!Authorization.md!} + +{!iTwinsRBACPermission.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/reality-management/v1/operations/update-reality-data/displayName.md b/services/reality-management/v1/operations/update-reality-data/displayName.md new file mode 100644 index 0000000..5277627 --- /dev/null +++ b/services/reality-management/v1/operations/update-reality-data/displayName.md @@ -0,0 +1 @@ +Update reality data \ No newline at end of file diff --git a/services/realityconversion/v1/description.md b/services/realityconversion/v1/description.md new file mode 100644 index 0000000..162ea17 --- /dev/null +++ b/services/realityconversion/v1/description.md @@ -0,0 +1 @@ +Convert mentioned point cloud formats to web-friendly Orbit Point Cloud. \ No newline at end of file diff --git a/services/realityconversion/v1/operations/jobs-create/description.md b/services/realityconversion/v1/operations/jobs-create/description.md new file mode 100644 index 0000000..e8f0764 --- /dev/null +++ b/services/realityconversion/v1/operations/jobs-create/description.md @@ -0,0 +1,8 @@ +--- + +Create a new job to convert point cloud formats to web-friendly Orbit Point Cloud or Cesium 3D Point Cloud. The POST request body MUST include type, name, inputs and outputs. +Accepted input formats for conversion are LAS, LAZ, PLY, E57 and ouput formats are OPC and PNTS. + +{!Authorization.md!} + +--- diff --git a/services/realityconversion/v1/operations/jobs-create/displayName.md b/services/realityconversion/v1/operations/jobs-create/displayName.md new file mode 100644 index 0000000..4d15e34 --- /dev/null +++ b/services/realityconversion/v1/operations/jobs-create/displayName.md @@ -0,0 +1 @@ +Create a job \ No newline at end of file diff --git a/services/realityconversion/v1/operations/jobs-delete/description.md b/services/realityconversion/v1/operations/jobs-delete/description.md new file mode 100644 index 0000000..03a90c5 --- /dev/null +++ b/services/realityconversion/v1/operations/jobs-delete/description.md @@ -0,0 +1,7 @@ +--- + +Delete an unsubmitted job. Job will not be deleted once it is in active state. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/realityconversion/v1/operations/jobs-delete/displayName.md b/services/realityconversion/v1/operations/jobs-delete/displayName.md new file mode 100644 index 0000000..10d06e5 --- /dev/null +++ b/services/realityconversion/v1/operations/jobs-delete/displayName.md @@ -0,0 +1 @@ +Delete Job \ No newline at end of file diff --git a/services/realityconversion/v1/operations/jobs-get/description.md b/services/realityconversion/v1/operations/jobs-get/description.md new file mode 100644 index 0000000..f5c58cf --- /dev/null +++ b/services/realityconversion/v1/operations/jobs-get/description.md @@ -0,0 +1,7 @@ +--- + +Retrieve job details. + +{!Authorization.md!} + +--- diff --git a/services/realityconversion/v1/operations/jobs-get/displayName.md b/services/realityconversion/v1/operations/jobs-get/displayName.md new file mode 100644 index 0000000..aed2bac --- /dev/null +++ b/services/realityconversion/v1/operations/jobs-get/displayName.md @@ -0,0 +1 @@ +Get a Job \ No newline at end of file diff --git a/services/realityconversion/v1/operations/jobs-patch/description.md b/services/realityconversion/v1/operations/jobs-patch/description.md new file mode 100644 index 0000000..d1a09d0 --- /dev/null +++ b/services/realityconversion/v1/operations/jobs-patch/description.md @@ -0,0 +1,7 @@ +--- + +Patch can be used for changing the job state (to active or cancelled), updating job type, inputs , outputs, options or changing cost estimation parameters. + +{!Authorization.md!} + +--- diff --git a/services/realityconversion/v1/operations/jobs-patch/displayName.md b/services/realityconversion/v1/operations/jobs-patch/displayName.md new file mode 100644 index 0000000..299f8ed --- /dev/null +++ b/services/realityconversion/v1/operations/jobs-patch/displayName.md @@ -0,0 +1 @@ +Modify a job \ No newline at end of file diff --git a/services/realityconversion/v1/operations/jobs-progress/description.md b/services/realityconversion/v1/operations/jobs-progress/description.md new file mode 100644 index 0000000..c2228e3 --- /dev/null +++ b/services/realityconversion/v1/operations/jobs-progress/description.md @@ -0,0 +1,7 @@ +--- + +Retrieve job progress. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/realityconversion/v1/operations/jobs-progress/displayName.md b/services/realityconversion/v1/operations/jobs-progress/displayName.md new file mode 100644 index 0000000..398686e --- /dev/null +++ b/services/realityconversion/v1/operations/jobs-progress/displayName.md @@ -0,0 +1 @@ +Get job progress \ No newline at end of file diff --git a/services/realitydataanalysis/v1/description.md b/services/realitydataanalysis/v1/description.md new file mode 100644 index 0000000..b0aa5d4 --- /dev/null +++ b/services/realitydataanalysis/v1/description.md @@ -0,0 +1,3 @@ +Interact with your data analysis jobs. + +Create, update, delete jobs. \ No newline at end of file diff --git a/services/realitydataanalysis/v1/operations/jobs-create/description.md b/services/realitydataanalysis/v1/operations/jobs-create/description.md new file mode 100644 index 0000000..6dcbd8f --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-create/description.md @@ -0,0 +1,7 @@ +--- + +Create a new job based on its type and options + +{!Authorization.md!} + +--- diff --git a/services/realitydataanalysis/v1/operations/jobs-create/displayName.md b/services/realitydataanalysis/v1/operations/jobs-create/displayName.md new file mode 100644 index 0000000..639217f --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-create/displayName.md @@ -0,0 +1 @@ +Create job \ No newline at end of file diff --git a/services/realitydataanalysis/v1/operations/jobs-delete/description.md b/services/realitydataanalysis/v1/operations/jobs-delete/description.md new file mode 100644 index 0000000..7ccd3bf --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-delete/description.md @@ -0,0 +1,7 @@ +--- + +Delete an unsubmitted job + +{!Authorization.md!} + +--- diff --git a/services/realitydataanalysis/v1/operations/jobs-delete/displayName.md b/services/realitydataanalysis/v1/operations/jobs-delete/displayName.md new file mode 100644 index 0000000..66cc192 --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-delete/displayName.md @@ -0,0 +1 @@ +Delete job \ No newline at end of file diff --git a/services/realitydataanalysis/v1/operations/jobs-get-all/description.md b/services/realitydataanalysis/v1/operations/jobs-get-all/description.md new file mode 100644 index 0000000..b11a081 --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-get-all/description.md @@ -0,0 +1,9 @@ +--- + +Retrieve list of jobs matching provided filter. + +The `iTwinId` in filter is optional. If it is not provided, this will return jobs created by the same user. However, if the iTwinId is provided and the user has access to it, this will return jobs associated with that specific iTwin. + +{!Authorization.md!} + +--- diff --git a/services/realitydataanalysis/v1/operations/jobs-get-all/displayName.md b/services/realitydataanalysis/v1/operations/jobs-get-all/displayName.md new file mode 100644 index 0000000..b9f1ebd --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-get-all/displayName.md @@ -0,0 +1 @@ +Get jobs \ No newline at end of file diff --git a/services/realitydataanalysis/v1/operations/jobs-get/description.md b/services/realitydataanalysis/v1/operations/jobs-get/description.md new file mode 100644 index 0000000..0daf46a --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-get/description.md @@ -0,0 +1,11 @@ +--- + +Retrieve job details, such as current state, execution information, outputs, etc. + +### Parameters + +The job id + +{!Authorization.md!} + +--- diff --git a/services/realitydataanalysis/v1/operations/jobs-get/displayName.md b/services/realitydataanalysis/v1/operations/jobs-get/displayName.md new file mode 100644 index 0000000..341fb1f --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-get/displayName.md @@ -0,0 +1 @@ +Get job \ No newline at end of file diff --git a/services/realitydataanalysis/v1/operations/jobs-patch/description.md b/services/realitydataanalysis/v1/operations/jobs-patch/description.md new file mode 100644 index 0000000..610d019 --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-patch/description.md @@ -0,0 +1,9 @@ +--- + +Patch an existing job + +Patch can be used for changing the job state (to active or cancelled), updating job type and options or changing cost estimation parameters. + +{!Authorization.md!} + +--- diff --git a/services/realitydataanalysis/v1/operations/jobs-patch/displayName.md b/services/realitydataanalysis/v1/operations/jobs-patch/displayName.md new file mode 100644 index 0000000..299f8ed --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-patch/displayName.md @@ -0,0 +1 @@ +Modify a job \ No newline at end of file diff --git a/services/realitydataanalysis/v1/operations/jobs-progress/description.md b/services/realitydataanalysis/v1/operations/jobs-progress/description.md new file mode 100644 index 0000000..ffb5ab3 --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-progress/description.md @@ -0,0 +1,17 @@ +--- + +Retrieve job progress. + +### Parameters + +The job id + +### Remarks + +The job progression is deemed valid when the job is active and won't be available after 30 days. + +Client should query with a backoff intervals [15,30,60,120] seconds. The interval between the first and second query is 15 sec and then 30 sec... If the percentage changes the sequence is restarted. + +{!Authorization.md!} + +--- diff --git a/services/realitydataanalysis/v1/operations/jobs-progress/displayName.md b/services/realitydataanalysis/v1/operations/jobs-progress/displayName.md new file mode 100644 index 0000000..398686e --- /dev/null +++ b/services/realitydataanalysis/v1/operations/jobs-progress/displayName.md @@ -0,0 +1 @@ +Get job progress \ No newline at end of file diff --git a/services/reporting/v2/description.md b/services/reporting/v2/description.md new file mode 100644 index 0000000..5b4efb3 --- /dev/null +++ b/services/reporting/v2/description.md @@ -0,0 +1,4 @@ +Reporting is a resource for aggregating iTwin data to build custom dashboards and integrate iTwin data with your business applications. + +- Create digitial twin based reports which can be consumed through business intelligence applications such as Power BI. +- Leverage the OData feed Data Access to generate reports by combining data from multiple data streams in the digital twin. \ No newline at end of file diff --git a/services/reporting/v2/operations/create-apikey/description.md b/services/reporting/v2/operations/create-apikey/description.md new file mode 100644 index 0000000..84565a7 --- /dev/null +++ b/services/reporting/v2/operations/create-apikey/description.md @@ -0,0 +1,15 @@ +--- + +Creates an ApiKey used to connect OData v4 compliant applications to [Data Access](/apis/insights-v2/operations/odata/) endpoints. + +The generated `apiKey` can be used in the password field of `Basic` authentication in applications or scipts, or used directly in the `Authorization` header of a request: `Authorization: Basic {apiKey}`. + +ApiKeys are valid for a maximum of 6 months and not extendable. ApiKeys must be rotated when they expire. + +{!ApiKeyTryItOutLimitations.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/create-apikey/displayName.md b/services/reporting/v2/operations/create-apikey/displayName.md new file mode 100644 index 0000000..0f4be1a --- /dev/null +++ b/services/reporting/v2/operations/create-apikey/displayName.md @@ -0,0 +1 @@ +Create ApiKey \ No newline at end of file diff --git a/services/reporting/v2/operations/create-report-mapping/description.md b/services/reporting/v2/operations/create-report-mapping/description.md new file mode 100644 index 0000000..f887a1f --- /dev/null +++ b/services/reporting/v2/operations/create-report-mapping/description.md @@ -0,0 +1,11 @@ +--- + +Creates a Report Mapping. Each one links a Mapping to a Report and each Report can have more than one Report Mapping. + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/create-report-mapping/displayName.md b/services/reporting/v2/operations/create-report-mapping/displayName.md new file mode 100644 index 0000000..acd1801 --- /dev/null +++ b/services/reporting/v2/operations/create-report-mapping/displayName.md @@ -0,0 +1 @@ +Create Report Mapping \ No newline at end of file diff --git a/services/reporting/v2/operations/create-report/description.md b/services/reporting/v2/operations/create-report/description.md new file mode 100644 index 0000000..a828ad1 --- /dev/null +++ b/services/reporting/v2/operations/create-report/description.md @@ -0,0 +1,11 @@ +--- + +Creates a Report within the context of a iTwin. + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/create-report/displayName.md b/services/reporting/v2/operations/create-report/displayName.md new file mode 100644 index 0000000..d4ee972 --- /dev/null +++ b/services/reporting/v2/operations/create-report/displayName.md @@ -0,0 +1 @@ +Create Report \ No newline at end of file diff --git a/services/reporting/v2/operations/delete-report-mapping/description.md b/services/reporting/v2/operations/delete-report-mapping/description.md new file mode 100644 index 0000000..91449c5 --- /dev/null +++ b/services/reporting/v2/operations/delete-report-mapping/description.md @@ -0,0 +1,11 @@ +--- + +Deletes a Report Mapping from a Report. + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/delete-report-mapping/displayName.md b/services/reporting/v2/operations/delete-report-mapping/displayName.md new file mode 100644 index 0000000..1bcca59 --- /dev/null +++ b/services/reporting/v2/operations/delete-report-mapping/displayName.md @@ -0,0 +1 @@ +Delete Report Mapping \ No newline at end of file diff --git a/services/reporting/v2/operations/delete-report/description.md b/services/reporting/v2/operations/delete-report/description.md new file mode 100644 index 0000000..853b614 --- /dev/null +++ b/services/reporting/v2/operations/delete-report/description.md @@ -0,0 +1,11 @@ +--- + +Marks a Report for deletion. Reports are permanently deleted one month after being marked for deletion. A Report marked for deletion can be restored if it hasn't been permanently deleted yet. + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/delete-report/displayName.md b/services/reporting/v2/operations/delete-report/displayName.md new file mode 100644 index 0000000..a1a6cb7 --- /dev/null +++ b/services/reporting/v2/operations/delete-report/displayName.md @@ -0,0 +1 @@ +Delete Report \ No newline at end of file diff --git a/services/reporting/v2/operations/get-apikey/description.md b/services/reporting/v2/operations/get-apikey/description.md new file mode 100644 index 0000000..bac04db --- /dev/null +++ b/services/reporting/v2/operations/get-apikey/description.md @@ -0,0 +1,9 @@ +--- + +Gets a single ApiKey. + +{!ApiKeyTryItOutLimitations.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/get-apikey/displayName.md b/services/reporting/v2/operations/get-apikey/displayName.md new file mode 100644 index 0000000..eba995a --- /dev/null +++ b/services/reporting/v2/operations/get-apikey/displayName.md @@ -0,0 +1 @@ +Get ApiKey \ No newline at end of file diff --git a/services/reporting/v2/operations/get-apikeys/description.md b/services/reporting/v2/operations/get-apikeys/description.md new file mode 100644 index 0000000..46bb145 --- /dev/null +++ b/services/reporting/v2/operations/get-apikeys/description.md @@ -0,0 +1,9 @@ +--- + +Gets all ApiKeys of the current user with an optional Report filter. + +{!ApiKeyTryItOutLimitations.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/get-apikeys/displayName.md b/services/reporting/v2/operations/get-apikeys/displayName.md new file mode 100644 index 0000000..f1460f7 --- /dev/null +++ b/services/reporting/v2/operations/get-apikeys/displayName.md @@ -0,0 +1 @@ +Get ApiKeys \ No newline at end of file diff --git a/services/reporting/v2/operations/get-itwin-reports/description.md b/services/reporting/v2/operations/get-itwin-reports/description.md new file mode 100644 index 0000000..3ee7e3b --- /dev/null +++ b/services/reporting/v2/operations/get-itwin-reports/description.md @@ -0,0 +1,11 @@ +--- + +Gets all Reports within the context of a iTwin. + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/get-itwin-reports/displayName.md b/services/reporting/v2/operations/get-itwin-reports/displayName.md new file mode 100644 index 0000000..c726f6d --- /dev/null +++ b/services/reporting/v2/operations/get-itwin-reports/displayName.md @@ -0,0 +1 @@ +Get iTwin Reports \ No newline at end of file diff --git a/services/reporting/v2/operations/get-report-mappings/description.md b/services/reporting/v2/operations/get-report-mappings/description.md new file mode 100644 index 0000000..432e00c --- /dev/null +++ b/services/reporting/v2/operations/get-report-mappings/description.md @@ -0,0 +1,11 @@ +--- + +Gets all Report Mappings for a Report. + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/get-report-mappings/displayName.md b/services/reporting/v2/operations/get-report-mappings/displayName.md new file mode 100644 index 0000000..48b876d --- /dev/null +++ b/services/reporting/v2/operations/get-report-mappings/displayName.md @@ -0,0 +1 @@ +Get Report Mappings \ No newline at end of file diff --git a/services/reporting/v2/operations/get-report/description.md b/services/reporting/v2/operations/get-report/description.md new file mode 100644 index 0000000..9a26919 --- /dev/null +++ b/services/reporting/v2/operations/get-report/description.md @@ -0,0 +1,11 @@ +--- + +Gets a single Report. + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/get-report/displayName.md b/services/reporting/v2/operations/get-report/displayName.md new file mode 100644 index 0000000..c3601ce --- /dev/null +++ b/services/reporting/v2/operations/get-report/displayName.md @@ -0,0 +1 @@ +Get Report \ No newline at end of file diff --git a/services/reporting/v2/operations/odata-entity/description.md b/services/reporting/v2/operations/odata-entity/description.md new file mode 100644 index 0000000..969226e --- /dev/null +++ b/services/reporting/v2/operations/odata-entity/description.md @@ -0,0 +1,13 @@ +--- + +Lists the raw table data for a Report Entity. + +{!OData.md!} + +{!ApiKeyAuthorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/odata-entity/displayName.md b/services/reporting/v2/operations/odata-entity/displayName.md new file mode 100644 index 0000000..0a6db6f --- /dev/null +++ b/services/reporting/v2/operations/odata-entity/displayName.md @@ -0,0 +1 @@ +OData Entity \ No newline at end of file diff --git a/services/reporting/v2/operations/odata-metadata/description.md b/services/reporting/v2/operations/odata-metadata/description.md new file mode 100644 index 0000000..3320630 --- /dev/null +++ b/services/reporting/v2/operations/odata-metadata/description.md @@ -0,0 +1,13 @@ +--- + +Lists schemas for all Entities tied to a Report. + +{!OData.md!} + +{!ApiKeyAuthorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/odata-metadata/displayName.md b/services/reporting/v2/operations/odata-metadata/displayName.md new file mode 100644 index 0000000..627a7b7 --- /dev/null +++ b/services/reporting/v2/operations/odata-metadata/displayName.md @@ -0,0 +1 @@ +OData Metadata \ No newline at end of file diff --git a/services/reporting/v2/operations/odata/description.md b/services/reporting/v2/operations/odata/description.md new file mode 100644 index 0000000..e2b18ab --- /dev/null +++ b/services/reporting/v2/operations/odata/description.md @@ -0,0 +1,13 @@ +--- + +Lists all OData Entities for a Report. This endpoint can be used as an OData feed in applications like Excel or Power BI. + +{!OData.md!} + +{!ApiKeyAuthorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/odata/displayName.md b/services/reporting/v2/operations/odata/displayName.md new file mode 100644 index 0000000..52fc7f5 --- /dev/null +++ b/services/reporting/v2/operations/odata/displayName.md @@ -0,0 +1 @@ +OData \ No newline at end of file diff --git a/services/reporting/v2/operations/revoke-apikey/description.md b/services/reporting/v2/operations/revoke-apikey/description.md new file mode 100644 index 0000000..ac2a8d2 --- /dev/null +++ b/services/reporting/v2/operations/revoke-apikey/description.md @@ -0,0 +1,9 @@ +--- + +Revokes an ApiKey. + +{!ApiKeyTryItOutLimitations.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/revoke-apikey/displayName.md b/services/reporting/v2/operations/revoke-apikey/displayName.md new file mode 100644 index 0000000..3db4940 --- /dev/null +++ b/services/reporting/v2/operations/revoke-apikey/displayName.md @@ -0,0 +1 @@ +Revoke ApiKey \ No newline at end of file diff --git a/services/reporting/v2/operations/update-apikey/description.md b/services/reporting/v2/operations/update-apikey/description.md new file mode 100644 index 0000000..aa28e26 --- /dev/null +++ b/services/reporting/v2/operations/update-apikey/description.md @@ -0,0 +1,9 @@ +--- + +Updates an ApiKey. + +{!ApiKeyTryItOutLimitations.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/update-apikey/displayName.md b/services/reporting/v2/operations/update-apikey/displayName.md new file mode 100644 index 0000000..df23e76 --- /dev/null +++ b/services/reporting/v2/operations/update-apikey/displayName.md @@ -0,0 +1 @@ +Update ApiKey \ No newline at end of file diff --git a/services/reporting/v2/operations/update-report/description.md b/services/reporting/v2/operations/update-report/description.md new file mode 100644 index 0000000..b92d4dc --- /dev/null +++ b/services/reporting/v2/operations/update-report/description.md @@ -0,0 +1,11 @@ +--- + +Updates a Report. + +{!Authorization.md!} + +{!InsightsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/reporting/v2/operations/update-report/displayName.md b/services/reporting/v2/operations/update-report/displayName.md new file mode 100644 index 0000000..b35b25d --- /dev/null +++ b/services/reporting/v2/operations/update-report/displayName.md @@ -0,0 +1 @@ +Update Report \ No newline at end of file diff --git a/services/savedviews/v1/description.md b/services/savedviews/v1/description.md new file mode 100644 index 0000000..c27e938 --- /dev/null +++ b/services/savedviews/v1/description.md @@ -0,0 +1,2 @@ + +The Saved Views API provides a central place to store view information so it can be retrieved or shared across applications. diff --git a/services/savedviews/v1/operations/add-image/description.md b/services/savedviews/v1/operations/add-image/description.md new file mode 100644 index 0000000..de89d95 --- /dev/null +++ b/services/savedviews/v1/operations/add-image/description.md @@ -0,0 +1,7 @@ +--- + +Allow uploading an image representing the saved view. Image will be available at full size and as a thumbnail size. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/add-image/displayName.md b/services/savedviews/v1/operations/add-image/displayName.md new file mode 100644 index 0000000..25cab0f --- /dev/null +++ b/services/savedviews/v1/operations/add-image/displayName.md @@ -0,0 +1 @@ +Update image \ No newline at end of file diff --git a/services/savedviews/v1/operations/create-extension/description.md b/services/savedviews/v1/operations/create-extension/description.md new file mode 100644 index 0000000..125e1b6 --- /dev/null +++ b/services/savedviews/v1/operations/create-extension/description.md @@ -0,0 +1,602 @@ +--- + +Creates an extension that contains custom data in a saved view. + +Extensions allow a saved view to be enhanced with custom data. The extensions have to be defined in a proprietary .JSON schema file. For now, only three extensions are available: +## Extension Schemas +The following extensions are available and are shown below in the details sections. +The details sections contain the schema followed by an example of that schema. +### Per Model Category Visibility - Schema +
+ Per Model Category Visibility Details +``` +[ + { + "type": "array", + "name": "perModelCategoryVisibilityProps", + "required": true, + "items": { + "type": "object", + "required": true, + "properties": [ + { + "name": "modelId", + "type": "Id64String", + "required": true + }, + { + "name": "categoryId", + "type": "Id64String", + "required": true + }, + { + "name": "visible", + "type": "boolean", + "required": true + } + ] + } + } +] +``` +Per Model Category Visibility - Example +``` +{ + "perModelCategoryVisibilityProps": [ + { + "modelId": "0x20000000079", + "categoryId": "0x2000000003e", + "visible": true + }, + { + "modelId": "0x20000000079", + "categoryId": "0x2000000004e", + "visible": false + } + ] +} +``` +
+### Emphasize Elements - Schema +
+ Emphasize Elements Details +``` +[ + { + "type": "object", + "name": "emphasizeElementsProps", + "required": true, + "properties": [ + { + "name": "neverDrawn", + "type": "array", + "required": false, + "items": { + "type": "Id64String" + } + }, + { + "name": "alwaysDrawn", + "type": "array", + "required": false, + "items": { + "type": "Id64String" + } + }, + { + "name": "isAlwaysDrawnExclusive", + "type": "boolean", + "required": false + }, + { + "name": "alwaysDrawnExclusiveEmphasized", + "type": "array", + "required": false, + "items": { + "type": "Id64String" + } + }, + { + "name": "defaultAppearance", + "type": "object", + "required": false, + "properties": [ + { + "name": "rgb", + "type": "object", + "properties": [ + { + "name": "r", + "type": "number", + "required": true + }, + { + "name": "g", + "type": "number", + "required": true + }, + { + "name": "b", + "type": "number", + "required": true + } + ] + }, + { + "name": "weight", + "type": "number" + }, + { + "name": "transparency", + "type": "number" + }, + { + "name": "viewDependentTransparency", + "type": "boolean" + }, + { + "name": "linePixels", + "type": "integer" + }, + { + "name": "ignoresMaterial", + "type": "boolean" + }, + { + "name": "nonLocatable", + "type": "boolean" + }, + { + "name": "emphasized", + "type": "boolean" + } + ] + }, + { + "name": "appearanceOverride", + "type": "array", + "items": { + "type": "object", + "properties": [ + { + "name": "overrideType", + "type": "integer" + }, + { + "name": "color", + "type": "number" + }, + { + "name": "ids", + "type": "array", + "items": { + "type": "Id64String" + } + } + ] + } + }, + { + "name": "wantEmphasis", + "type": "boolean" + }, + { + "name": "unanimatedAppearance", + "type": "object", + "required": false, + "properties": [ + { + "name": "rgb", + "type": "object", + "properties": [ + { + "name": "r", + "type": "number", + "required": true + }, + { + "name": "g", + "type": "number", + "required": true + }, + { + "name": "b", + "type": "number", + "required": true + } + ] + }, + { + "name": "weight", + "type": "number" + }, + { + "name": "transparency", + "type": "number" + }, + { + "name": "viewDependentTransparency", + "type": "boolean" + }, + { + "name": "linePixels", + "type": "integer" + }, + { + "name": "ignoresMaterial", + "type": "boolean" + }, + { + "name": "nonLocatable", + "type": "boolean" + }, + { + "name": "emphasized", + "type": "boolean" + } + ] + } + ] + } +] +``` +Emphasize Elements - Example +``` +{ + "emphasizeElementsProps": { + "neverDrawn": [ + "0x20000003865", + "0x20000003864", + "0x200000055e4", + "0x200000055e3", + "0x200000039af", + "0x200000039ae" + ] + } +} +``` +
+### Visibility Override - Schema +
+ Visibility Override Details +``` +[ + { + "name": "visibilityOverrideProps", + "type": "object", + "required": true, + "properties": [ + { + "name": "subCategoryOverrides", + "type": "array", + "items": { + "type": "object", + "properties": [ + { + "name": "ids", + "type": "array", + "required": true, + "items": { + "type": "Id64String" + } + }, + { + "name": "app", + "type": "object", + "required": true, + "properties": [ + { + "name": "rgb", + "type": "object", + "properties": [ + { + "name": "r", + "type": "number", + "required": true + }, + { + "name": "g", + "type": "number", + "required": true + }, + { + "name": "b", + "type": "number", + "required": true + } + ] + }, + { + "name": "weight", + "type": "number" + }, + { + "name": "transparency", + "type": "number" + }, + { + "name": "viewDependentTransparency", + "type": "boolean" + }, + { + "name": "linePixels", + "type": "integer" + }, + { + "name": "ignoresMaterial", + "type": "boolean" + }, + { + "name": "nonLocatable", + "type": "boolean" + }, + { + "name": "emphasized", + "type": "boolean" + } + ] + } + ] + } + }, + { + "name": "modelOverrides", + "type": "array", + "items": { + "type": "object", + "properties": [ + { + "name": "ids", + "type": "array", + "required": true, + "items": { + "type": "Id64String" + } + }, + { + "name": "app", + "type": "object", + "required": true, + "properties": [ + { + "name": "rgb", + "type": "object", + "properties": [ + { + "name": "r", + "type": "number", + "required": true + }, + { + "name": "g", + "type": "number", + "required": true + }, + { + "name": "b", + "type": "number", + "required": true + } + ] + }, + { + "name": "weight", + "type": "number" + }, + { + "name": "transparency", + "type": "number" + }, + { + "name": "viewDependentTransparency", + "type": "boolean" + }, + { + "name": "linePixels", + "type": "integer" + }, + { + "name": "ignoresMaterial", + "type": "boolean" + }, + { + "name": "nonLocatable", + "type": "boolean" + }, + { + "name": "emphasized", + "type": "boolean" + } + ] + } + ] + } + }, + { + "name": "catEmphasizeOverride", + "type": "object", + "properties": [ + { + "name": "ids", + "type": "array", + "required": true, + "items": { + "type": "Id64String" + } + }, + { + "name": "app", + "type": "object", + "required": true, + "properties": [ + { + "name": "rgb", + "type": "object", + "properties": [ + { + "name": "r", + "type": "number", + "required": true + }, + { + "name": "g", + "type": "number", + "required": true + }, + { + "name": "b", + "type": "number", + "required": true + } + ] + }, + { + "name": "weight", + "type": "number" + }, + { + "name": "transparency", + "type": "number" + }, + { + "name": "viewDependentTransparency", + "type": "boolean" + }, + { + "name": "linePixels", + "type": "integer" + }, + { + "name": "ignoresMaterial", + "type": "boolean" + }, + { + "name": "nonLocatable", + "type": "boolean" + }, + { + "name": "emphasized", + "type": "boolean" + } + ] + } + ] + }, + { + "name": "modelEmphasizeOverride", + "type": "object", + "properties": [ + { + "name": "ids", + "type": "array", + "required": true, + "items": { + "type": "Id64String" + } + }, + { + "name": "app", + "type": "object", + "required": true, + "properties": [ + { + "name": "rgb", + "type": "object", + "properties": [ + { + "name": "r", + "type": "number", + "required": true + }, + { + "name": "g", + "type": "number", + "required": true + }, + { + "name": "b", + "type": "number", + "required": true + } + ] + }, + { + "name": "weight", + "type": "number" + }, + { + "name": "transparency", + "type": "number" + }, + { + "name": "viewDependentTransparency", + "type": "boolean" + }, + { + "name": "linePixels", + "type": "integer" + }, + { + "name": "ignoresMaterial", + "type": "boolean" + }, + { + "name": "nonLocatable", + "type": "boolean" + }, + { + "name": "emphasized", + "type": "boolean" + } + ] + } + ] + } + ] + } +] +``` +Visibility Override - Example +``` +{ + "visibilityOverrideProps": { + "subCategoryOverrides": [ + { + "ids": [ + "0x200000009e5", + "0x20000000a45" + ], + "app": { + "rgb": { + "r": 12, + "g": 12, + "b": 107 + }, + "transparency": 0.46 + } + }, + { + "ids": [ + "0x20000007771", + "0x20000007810" + ], + "app": { + "rgb": { + "r": 12, + "g": 12, + "b": 107 + }, + "transparency": 0.46 + } + } + ] + } +} +``` +
+ +Later on, consumers of the API will be allowed to define their own extensions. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/create-extension/displayName.md b/services/savedviews/v1/operations/create-extension/displayName.md new file mode 100644 index 0000000..1d19b27 --- /dev/null +++ b/services/savedviews/v1/operations/create-extension/displayName.md @@ -0,0 +1 @@ +Create Extension \ No newline at end of file diff --git a/services/savedviews/v1/operations/create-group/description.md b/services/savedviews/v1/operations/create-group/description.md new file mode 100644 index 0000000..e318a92 --- /dev/null +++ b/services/savedviews/v1/operations/create-group/description.md @@ -0,0 +1,9 @@ +--- + +Creates a group to organize saved views. + +Note: any string parameter being passed in the payload will be rejected if it contains any of the following characters: `<, >, &, ", ', .` + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/create-group/displayName.md b/services/savedviews/v1/operations/create-group/displayName.md new file mode 100644 index 0000000..ba6c876 --- /dev/null +++ b/services/savedviews/v1/operations/create-group/displayName.md @@ -0,0 +1 @@ +Create group \ No newline at end of file diff --git a/services/savedviews/v1/operations/create-savedview/description.md b/services/savedviews/v1/operations/create-savedview/description.md new file mode 100644 index 0000000..e820722 --- /dev/null +++ b/services/savedviews/v1/operations/create-savedview/description.md @@ -0,0 +1,9 @@ +--- + +Creates a saved view. The saved view must include one an only view: 3D, Sheet or Drawing. + +Note: any string parameter being passed in the payload will be rejected if it contains any of the following characters: `<, >, &, ", ', .` + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/create-savedview/displayName.md b/services/savedviews/v1/operations/create-savedview/displayName.md new file mode 100644 index 0000000..1a08750 --- /dev/null +++ b/services/savedviews/v1/operations/create-savedview/displayName.md @@ -0,0 +1 @@ +Create saved view \ No newline at end of file diff --git a/services/savedviews/v1/operations/create-tag/description.md b/services/savedviews/v1/operations/create-tag/description.md new file mode 100644 index 0000000..87b0c4e --- /dev/null +++ b/services/savedviews/v1/operations/create-tag/description.md @@ -0,0 +1,9 @@ +--- + +Creates a tag to organize saved views. + +Note: any string parameter being passed in the payload will be rejected if it contains any of the following characters: `<, >, &, ", ', .` + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/create-tag/displayName.md b/services/savedviews/v1/operations/create-tag/displayName.md new file mode 100644 index 0000000..185a205 --- /dev/null +++ b/services/savedviews/v1/operations/create-tag/displayName.md @@ -0,0 +1 @@ +Create tag \ No newline at end of file diff --git a/services/savedviews/v1/operations/delete-extension/description.md b/services/savedviews/v1/operations/delete-extension/description.md new file mode 100644 index 0000000..4d8cdea --- /dev/null +++ b/services/savedviews/v1/operations/delete-extension/description.md @@ -0,0 +1,7 @@ +--- + +Deletes an extension in a saved view. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/delete-extension/displayName.md b/services/savedviews/v1/operations/delete-extension/displayName.md new file mode 100644 index 0000000..fbbe981 --- /dev/null +++ b/services/savedviews/v1/operations/delete-extension/displayName.md @@ -0,0 +1 @@ +Delete extension \ No newline at end of file diff --git a/services/savedviews/v1/operations/delete-group/description.md b/services/savedviews/v1/operations/delete-group/description.md new file mode 100644 index 0000000..0403ede --- /dev/null +++ b/services/savedviews/v1/operations/delete-group/description.md @@ -0,0 +1,7 @@ +--- + +Deletes a group, saved views assigned to that group will not be deleted. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/delete-group/displayName.md b/services/savedviews/v1/operations/delete-group/displayName.md new file mode 100644 index 0000000..aa366a4 --- /dev/null +++ b/services/savedviews/v1/operations/delete-group/displayName.md @@ -0,0 +1 @@ +Delete group \ No newline at end of file diff --git a/services/savedviews/v1/operations/delete-savedview/description.md b/services/savedviews/v1/operations/delete-savedview/description.md new file mode 100644 index 0000000..9e89b72 --- /dev/null +++ b/services/savedviews/v1/operations/delete-savedview/description.md @@ -0,0 +1,7 @@ +--- + +Deletes a saved view, images assigned to that saved view will be deleted as well. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/delete-savedview/displayName.md b/services/savedviews/v1/operations/delete-savedview/displayName.md new file mode 100644 index 0000000..a3886e7 --- /dev/null +++ b/services/savedviews/v1/operations/delete-savedview/displayName.md @@ -0,0 +1 @@ +Delete saved view \ No newline at end of file diff --git a/services/savedviews/v1/operations/delete-tag/description.md b/services/savedviews/v1/operations/delete-tag/description.md new file mode 100644 index 0000000..cdd9610 --- /dev/null +++ b/services/savedviews/v1/operations/delete-tag/description.md @@ -0,0 +1,7 @@ +--- + +Deletes a tag, tags must be unassigned from every saved view before they can be deleted. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/delete-tag/displayName.md b/services/savedviews/v1/operations/delete-tag/displayName.md new file mode 100644 index 0000000..fdb53f6 --- /dev/null +++ b/services/savedviews/v1/operations/delete-tag/displayName.md @@ -0,0 +1 @@ +Delete tag \ No newline at end of file diff --git a/services/savedviews/v1/operations/get-all-extensions/description.md b/services/savedviews/v1/operations/get-all-extensions/description.md new file mode 100644 index 0000000..d107ac0 --- /dev/null +++ b/services/savedviews/v1/operations/get-all-extensions/description.md @@ -0,0 +1,7 @@ +--- + +Get a list of extensions that exist in a saved view. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/get-all-extensions/displayName.md b/services/savedviews/v1/operations/get-all-extensions/displayName.md new file mode 100644 index 0000000..ed74b5f --- /dev/null +++ b/services/savedviews/v1/operations/get-all-extensions/displayName.md @@ -0,0 +1 @@ +Get all extensions \ No newline at end of file diff --git a/services/savedviews/v1/operations/get-all-groups/description.md b/services/savedviews/v1/operations/get-all-groups/description.md new file mode 100644 index 0000000..f57920a --- /dev/null +++ b/services/savedviews/v1/operations/get-all-groups/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves all groups associated to a iTwin or iTwin/iModel combination. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/get-all-groups/displayName.md b/services/savedviews/v1/operations/get-all-groups/displayName.md new file mode 100644 index 0000000..546bf56 --- /dev/null +++ b/services/savedviews/v1/operations/get-all-groups/displayName.md @@ -0,0 +1 @@ +Get all groups \ No newline at end of file diff --git a/services/savedviews/v1/operations/get-all-savedviews/description.md b/services/savedviews/v1/operations/get-all-savedviews/description.md new file mode 100644 index 0000000..d1e9ec5 --- /dev/null +++ b/services/savedviews/v1/operations/get-all-savedviews/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves all saved view associated to a iTwin, iTwin/iModel combination or group, at least one parameter must be provided. + +This operation supports pagination and will sort saved views by displayName. + +As the view data can be quite large, this collection call will not contain the view data themselves. To retrieve the data, make a call to [Get saved view](../get-savedview) + +Extension data is returned as a list of links to query further. If you want to obtain the full saved view data, including extension data, use the `Prefer` header with `return=representation`. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/get-all-savedviews/displayName.md b/services/savedviews/v1/operations/get-all-savedviews/displayName.md new file mode 100644 index 0000000..08e3aeb --- /dev/null +++ b/services/savedviews/v1/operations/get-all-savedviews/displayName.md @@ -0,0 +1 @@ +Get all saved views \ No newline at end of file diff --git a/services/savedviews/v1/operations/get-all-tags/description.md b/services/savedviews/v1/operations/get-all-tags/description.md new file mode 100644 index 0000000..bd8d0aa --- /dev/null +++ b/services/savedviews/v1/operations/get-all-tags/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves all tags associated to a iTwin or iTwin/iModel combination. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/get-all-tags/displayName.md b/services/savedviews/v1/operations/get-all-tags/displayName.md new file mode 100644 index 0000000..bd7d431 --- /dev/null +++ b/services/savedviews/v1/operations/get-all-tags/displayName.md @@ -0,0 +1 @@ +Get all tags \ No newline at end of file diff --git a/services/savedviews/v1/operations/get-extension/description.md b/services/savedviews/v1/operations/get-extension/description.md new file mode 100644 index 0000000..327f026 --- /dev/null +++ b/services/savedviews/v1/operations/get-extension/description.md @@ -0,0 +1,7 @@ +--- + +Get an extension from a saved view. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/get-extension/displayName.md b/services/savedviews/v1/operations/get-extension/displayName.md new file mode 100644 index 0000000..7fb0911 --- /dev/null +++ b/services/savedviews/v1/operations/get-extension/displayName.md @@ -0,0 +1 @@ +Get extension \ No newline at end of file diff --git a/services/savedviews/v1/operations/get-group/description.md b/services/savedviews/v1/operations/get-group/description.md new file mode 100644 index 0000000..2419a1a --- /dev/null +++ b/services/savedviews/v1/operations/get-group/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves information for a single group. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/get-group/displayName.md b/services/savedviews/v1/operations/get-group/displayName.md new file mode 100644 index 0000000..aaeb30c --- /dev/null +++ b/services/savedviews/v1/operations/get-group/displayName.md @@ -0,0 +1 @@ +Get group \ No newline at end of file diff --git a/services/savedviews/v1/operations/get-image/description.md b/services/savedviews/v1/operations/get-image/description.md new file mode 100644 index 0000000..3655ec8 --- /dev/null +++ b/services/savedviews/v1/operations/get-image/description.md @@ -0,0 +1,7 @@ +--- + +Generates or retrieves an Url for the image or thumbnail associated to a saved view. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/get-image/displayName.md b/services/savedviews/v1/operations/get-image/displayName.md new file mode 100644 index 0000000..c56155e --- /dev/null +++ b/services/savedviews/v1/operations/get-image/displayName.md @@ -0,0 +1 @@ +Get image \ No newline at end of file diff --git a/services/savedviews/v1/operations/get-savedview/description.md b/services/savedviews/v1/operations/get-savedview/description.md new file mode 100644 index 0000000..b04a3b9 --- /dev/null +++ b/services/savedviews/v1/operations/get-savedview/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a saved view. Extension data is returned as a list of links to query further. If you want to obtain the full saved view data, including extension data, use the `Prefer` header with `return=representation`. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/get-savedview/displayName.md b/services/savedviews/v1/operations/get-savedview/displayName.md new file mode 100644 index 0000000..546a73a --- /dev/null +++ b/services/savedviews/v1/operations/get-savedview/displayName.md @@ -0,0 +1 @@ +Get saved view \ No newline at end of file diff --git a/services/savedviews/v1/operations/get-tag/description.md b/services/savedviews/v1/operations/get-tag/description.md new file mode 100644 index 0000000..9d8aa9a --- /dev/null +++ b/services/savedviews/v1/operations/get-tag/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves information for a single tag. + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/get-tag/displayName.md b/services/savedviews/v1/operations/get-tag/displayName.md new file mode 100644 index 0000000..eb7bec3 --- /dev/null +++ b/services/savedviews/v1/operations/get-tag/displayName.md @@ -0,0 +1 @@ +Get tag \ No newline at end of file diff --git a/services/savedviews/v1/operations/update-group/description.md b/services/savedviews/v1/operations/update-group/description.md new file mode 100644 index 0000000..10e944c --- /dev/null +++ b/services/savedviews/v1/operations/update-group/description.md @@ -0,0 +1,9 @@ +--- + +Updates a group. + +Note: any string parameter being passed in the payload will be rejected if it contains any of the following characters: `<, >, &, ", ', .` + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/update-group/displayName.md b/services/savedviews/v1/operations/update-group/displayName.md new file mode 100644 index 0000000..60cfcae --- /dev/null +++ b/services/savedviews/v1/operations/update-group/displayName.md @@ -0,0 +1 @@ +Update group \ No newline at end of file diff --git a/services/savedviews/v1/operations/update-savedview/description.md b/services/savedviews/v1/operations/update-savedview/description.md new file mode 100644 index 0000000..48762d4 --- /dev/null +++ b/services/savedviews/v1/operations/update-savedview/description.md @@ -0,0 +1,9 @@ +--- + +Updates a saved view. + +Note: any string parameter being passed in the payload will be rejected if it contains any of the following characters: `<, >, &, ", ', .` + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/update-savedview/displayName.md b/services/savedviews/v1/operations/update-savedview/displayName.md new file mode 100644 index 0000000..becbe5d --- /dev/null +++ b/services/savedviews/v1/operations/update-savedview/displayName.md @@ -0,0 +1 @@ +Update saved view \ No newline at end of file diff --git a/services/savedviews/v1/operations/update-tag/description.md b/services/savedviews/v1/operations/update-tag/description.md new file mode 100644 index 0000000..fda80ea --- /dev/null +++ b/services/savedviews/v1/operations/update-tag/description.md @@ -0,0 +1,9 @@ +--- + +Renames a tag. + +Note: any string parameter being passed in the payload will be rejected if it contains any of the following characters: `<, >, &, ", ', .` + +{!Authorization.md!} + +--- diff --git a/services/savedviews/v1/operations/update-tag/displayName.md b/services/savedviews/v1/operations/update-tag/displayName.md new file mode 100644 index 0000000..bdc4ea3 --- /dev/null +++ b/services/savedviews/v1/operations/update-tag/displayName.md @@ -0,0 +1 @@ +Update tag \ No newline at end of file diff --git a/services/sensor-data/v1/description.md b/services/sensor-data/v1/description.md new file mode 100644 index 0000000..ef9ecbb --- /dev/null +++ b/services/sensor-data/v1/description.md @@ -0,0 +1 @@ +The Sensor Data Service (SDS) provides a unified method for publishing time series sensor data (and related metadata) within iTwin IoT. The SDS simplifies the process of connecting sensor data from sources including IoT Devices, IaaS IoT Hubs, Enterprise Systems, and other generic repositories. Availability of this data enables developers, vendors, and users to develop OT workflows to create new use cases for digital twins in their projects. diff --git a/services/sensor-data/v1/operations/get-nodes/description.md b/services/sensor-data/v1/operations/get-nodes/description.md new file mode 100644 index 0000000..89e3740 --- /dev/null +++ b/services/sensor-data/v1/operations/get-nodes/description.md @@ -0,0 +1,11 @@ +--- + +Gets all Nodes. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +--- diff --git a/services/sensor-data/v1/operations/get-nodes/displayName.md b/services/sensor-data/v1/operations/get-nodes/displayName.md new file mode 100644 index 0000000..cb512f7 --- /dev/null +++ b/services/sensor-data/v1/operations/get-nodes/displayName.md @@ -0,0 +1 @@ +Get Nodes \ No newline at end of file diff --git a/services/sensor-data/v1/operations/process-integration/description.md b/services/sensor-data/v1/operations/process-integration/description.md new file mode 100644 index 0000000..b9acd76 --- /dev/null +++ b/services/sensor-data/v1/operations/process-integration/description.md @@ -0,0 +1,7 @@ +--- + +Processes an integration. + +{!Authorization.md!} + +--- diff --git a/services/sensor-data/v1/operations/process-integration/displayName.md b/services/sensor-data/v1/operations/process-integration/displayName.md new file mode 100644 index 0000000..fce6b73 --- /dev/null +++ b/services/sensor-data/v1/operations/process-integration/displayName.md @@ -0,0 +1 @@ +Process Integration \ No newline at end of file diff --git a/services/sensor-data/v1/operations/query-raw-data/description.md b/services/sensor-data/v1/operations/query-raw-data/description.md new file mode 100644 index 0000000..87d0d09 --- /dev/null +++ b/services/sensor-data/v1/operations/query-raw-data/description.md @@ -0,0 +1,11 @@ +--- + +Query time-series sensor readings. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +--- diff --git a/services/sensor-data/v1/operations/query-raw-data/displayName.md b/services/sensor-data/v1/operations/query-raw-data/displayName.md new file mode 100644 index 0000000..f83296f --- /dev/null +++ b/services/sensor-data/v1/operations/query-raw-data/displayName.md @@ -0,0 +1 @@ +Query Raw Data \ No newline at end of file diff --git a/services/sensor-data/v1/operations/remove-data/description.md b/services/sensor-data/v1/operations/remove-data/description.md new file mode 100644 index 0000000..9c4a086 --- /dev/null +++ b/services/sensor-data/v1/operations/remove-data/description.md @@ -0,0 +1,11 @@ +--- + +Remove time-series sensor readings. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +--- diff --git a/services/sensor-data/v1/operations/remove-data/displayName.md b/services/sensor-data/v1/operations/remove-data/displayName.md new file mode 100644 index 0000000..ab2980b --- /dev/null +++ b/services/sensor-data/v1/operations/remove-data/displayName.md @@ -0,0 +1 @@ +Remove Data \ No newline at end of file diff --git a/services/sensor-data/v1/operations/upload-data/description.md b/services/sensor-data/v1/operations/upload-data/description.md new file mode 100644 index 0000000..efe0660 --- /dev/null +++ b/services/sensor-data/v1/operations/upload-data/description.md @@ -0,0 +1,7 @@ +--- + +Upload time-series sensor readings. + +{!Authorization.md!} + +--- diff --git a/services/sensor-data/v1/operations/upload-data/displayName.md b/services/sensor-data/v1/operations/upload-data/displayName.md new file mode 100644 index 0000000..62c2acb --- /dev/null +++ b/services/sensor-data/v1/operations/upload-data/displayName.md @@ -0,0 +1 @@ +Upload Data \ No newline at end of file diff --git a/services/storage-container/v1/description.md b/services/storage-container/v1/description.md new file mode 100644 index 0000000..f82fc69 --- /dev/null +++ b/services/storage-container/v1/description.md @@ -0,0 +1 @@ +CRUD API for creating and managing Cloud Storage Containers. \ No newline at end of file diff --git a/services/storage-container/v1/operations/clone-storage-container/description.md b/services/storage-container/v1/operations/clone-storage-container/description.md new file mode 100644 index 0000000..7741020 --- /dev/null +++ b/services/storage-container/v1/operations/clone-storage-container/description.md @@ -0,0 +1,7 @@ +--- + +Generates a copy of an existing container and copies all blobs into the new container. The new container will have the same containerType as the original. If no new metadata is provided, the existing container's metadata will be used. Returns the new container's info. + +{!Authorization.md!} + +--- diff --git a/services/storage-container/v1/operations/clone-storage-container/displayName.md b/services/storage-container/v1/operations/clone-storage-container/displayName.md new file mode 100644 index 0000000..196b881 --- /dev/null +++ b/services/storage-container/v1/operations/clone-storage-container/displayName.md @@ -0,0 +1 @@ +Clone Storage Container \ No newline at end of file diff --git a/services/storage-container/v1/operations/create-storage-container/description.md b/services/storage-container/v1/operations/create-storage-container/description.md new file mode 100644 index 0000000..be5dfda --- /dev/null +++ b/services/storage-container/v1/operations/create-storage-container/description.md @@ -0,0 +1,7 @@ +--- + +Creates a new Storage Container associated with the supplied iTwinID. + +{!Authorization.md!} + +--- diff --git a/services/storage-container/v1/operations/create-storage-container/displayName.md b/services/storage-container/v1/operations/create-storage-container/displayName.md new file mode 100644 index 0000000..8caf5b2 --- /dev/null +++ b/services/storage-container/v1/operations/create-storage-container/displayName.md @@ -0,0 +1 @@ +Create Storage Container \ No newline at end of file diff --git a/services/storage-container/v1/operations/delete-storage-container/description.md b/services/storage-container/v1/operations/delete-storage-container/description.md new file mode 100644 index 0000000..289bed1 --- /dev/null +++ b/services/storage-container/v1/operations/delete-storage-container/description.md @@ -0,0 +1,7 @@ +--- + +Deletes the Storage Container based on the supplied containerId. + +{!Authorization.md!} + +--- diff --git a/services/storage-container/v1/operations/delete-storage-container/displayName.md b/services/storage-container/v1/operations/delete-storage-container/displayName.md new file mode 100644 index 0000000..4ec8183 --- /dev/null +++ b/services/storage-container/v1/operations/delete-storage-container/displayName.md @@ -0,0 +1 @@ +Delete Storage Container \ No newline at end of file diff --git a/services/storage-container/v1/operations/get-single-storage-container/description.md b/services/storage-container/v1/operations/get-single-storage-container/description.md new file mode 100644 index 0000000..70855ab --- /dev/null +++ b/services/storage-container/v1/operations/get-single-storage-container/description.md @@ -0,0 +1,7 @@ +--- + +Get a single Storage Container with access information based on the supplied containerId. + +{!Authorization.md!} + +--- diff --git a/services/storage-container/v1/operations/get-single-storage-container/displayName.md b/services/storage-container/v1/operations/get-single-storage-container/displayName.md new file mode 100644 index 0000000..cdbfbf0 --- /dev/null +++ b/services/storage-container/v1/operations/get-single-storage-container/displayName.md @@ -0,0 +1 @@ +Get Single Storage Container \ No newline at end of file diff --git a/services/storage-container/v1/operations/get-storage-containers/description.md b/services/storage-container/v1/operations/get-storage-containers/description.md new file mode 100644 index 0000000..c7c7c1b --- /dev/null +++ b/services/storage-container/v1/operations/get-storage-containers/description.md @@ -0,0 +1,7 @@ +--- + +Lists all Storage Containers and their metadata associated with a given iTwinID. Query can be further filtered based on iModelId, label, or containerType. Request must contain provide an iTwinId. + +{!Authorization.md!} + +--- diff --git a/services/storage-container/v1/operations/get-storage-containers/displayName.md b/services/storage-container/v1/operations/get-storage-containers/displayName.md new file mode 100644 index 0000000..af61e22 --- /dev/null +++ b/services/storage-container/v1/operations/get-storage-containers/displayName.md @@ -0,0 +1 @@ +Get Storage Containers \ No newline at end of file diff --git a/services/storage-container/v1/operations/update-container-metadata-json/description.md b/services/storage-container/v1/operations/update-container-metadata-json/description.md new file mode 100644 index 0000000..6651883 --- /dev/null +++ b/services/storage-container/v1/operations/update-container-metadata-json/description.md @@ -0,0 +1,7 @@ +--- + +Updates the "json" inside the metadata of a Storage Container. + +{!Authorization.md!} + +--- diff --git a/services/storage-container/v1/operations/update-container-metadata-json/displayName.md b/services/storage-container/v1/operations/update-container-metadata-json/displayName.md new file mode 100644 index 0000000..7963d9c --- /dev/null +++ b/services/storage-container/v1/operations/update-container-metadata-json/displayName.md @@ -0,0 +1 @@ +Update Container Metadata JSON \ No newline at end of file diff --git a/services/storage/v1/description.md b/services/storage/v1/description.md new file mode 100644 index 0000000..302eaa9 --- /dev/null +++ b/services/storage/v1/description.md @@ -0,0 +1 @@ +Storage API allowing quick files managing \ No newline at end of file diff --git a/services/storage/v1/operations/complete-file-creation/description.md b/services/storage/v1/operations/complete-file-creation/description.md new file mode 100644 index 0000000..5f67ce8 --- /dev/null +++ b/services/storage/v1/operations/complete-file-creation/description.md @@ -0,0 +1,9 @@ +--- + +Complete file creation + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/storage/v1/operations/complete-file-creation/displayName.md b/services/storage/v1/operations/complete-file-creation/displayName.md new file mode 100644 index 0000000..405f4ee --- /dev/null +++ b/services/storage/v1/operations/complete-file-creation/displayName.md @@ -0,0 +1 @@ +Complete file upload \ No newline at end of file diff --git a/services/storage/v1/operations/create-file/description.md b/services/storage/v1/operations/create-file/description.md new file mode 100644 index 0000000..b6449c7 --- /dev/null +++ b/services/storage/v1/operations/create-file/description.md @@ -0,0 +1,24 @@ +--- + +Create new file + +### Notes + +File creation is three steps operation. This request will create file's meta data. Next two requests need to be executed by using links from the response. Maximum file size to upload with single request is **256 MiB**. If bigger file needs to be uploaded there are possibility to use Azure libraries to upload file via given Azure SAS url or by uploading file with [multiple requests](https://docs.microsoft.com/en-us/rest/api/storageservices/operations-on-block-blobs). + +- **uploadUrl** is required for file upload. Upload can be done by sending http request and specifying x-ms-blob-type header to BlockBlob. +- **completeUrl** should be used to confirm file upload and it is final request for file creation. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +### Errors + +This request can return InvalidCreateFileRequest error with 422 status code. This could happen because of these reasons: + +- File name contains invalid characters. +- File name's length is larger than 255 characters. +- File could be harmful. For example, executable files are not accepted. + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/create-file/displayName.md b/services/storage/v1/operations/create-file/displayName.md new file mode 100644 index 0000000..d0c3c01 --- /dev/null +++ b/services/storage/v1/operations/create-file/displayName.md @@ -0,0 +1 @@ +Create file \ No newline at end of file diff --git a/services/storage/v1/operations/create-folder/description.md b/services/storage/v1/operations/create-folder/description.md new file mode 100644 index 0000000..8d674a7 --- /dev/null +++ b/services/storage/v1/operations/create-folder/description.md @@ -0,0 +1,16 @@ +--- + +Create new folder + +{!Authorization.md!} + +{!RbacPermissions.md!} + +### Errors + +This request can return InvalidCreateFolderRequest error with 422 status code. This could happen because of these reasons: + +- Folder name contains invalid characters. +- Folder name's length is larger than 255 characters. + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/create-folder/displayName.md b/services/storage/v1/operations/create-folder/displayName.md new file mode 100644 index 0000000..981ca2c --- /dev/null +++ b/services/storage/v1/operations/create-folder/displayName.md @@ -0,0 +1 @@ +Create folder \ No newline at end of file diff --git a/services/storage/v1/operations/delete-file-from-recycle-bin/description.md b/services/storage/v1/operations/delete-file-from-recycle-bin/description.md new file mode 100644 index 0000000..4b2721a --- /dev/null +++ b/services/storage/v1/operations/delete-file-from-recycle-bin/description.md @@ -0,0 +1,9 @@ +--- + +Delete a file from the recycle bin + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/delete-file-from-recycle-bin/displayName.md b/services/storage/v1/operations/delete-file-from-recycle-bin/displayName.md new file mode 100644 index 0000000..974a20a --- /dev/null +++ b/services/storage/v1/operations/delete-file-from-recycle-bin/displayName.md @@ -0,0 +1 @@ +Delete file from recycle bin \ No newline at end of file diff --git a/services/storage/v1/operations/delete-file/description.md b/services/storage/v1/operations/delete-file/description.md new file mode 100644 index 0000000..f377a48 --- /dev/null +++ b/services/storage/v1/operations/delete-file/description.md @@ -0,0 +1,13 @@ +--- + +Delete a file + +### Notes + +File moved to the recycle bin will be completely removed after 30 days. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/delete-file/displayName.md b/services/storage/v1/operations/delete-file/displayName.md new file mode 100644 index 0000000..0e7498f --- /dev/null +++ b/services/storage/v1/operations/delete-file/displayName.md @@ -0,0 +1 @@ +Delete file \ No newline at end of file diff --git a/services/storage/v1/operations/delete-folder-from-recycle-bin/description.md b/services/storage/v1/operations/delete-folder-from-recycle-bin/description.md new file mode 100644 index 0000000..ef3a271 --- /dev/null +++ b/services/storage/v1/operations/delete-folder-from-recycle-bin/description.md @@ -0,0 +1,9 @@ +--- + +Delete a folder from the recycle bin + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/delete-folder-from-recycle-bin/displayName.md b/services/storage/v1/operations/delete-folder-from-recycle-bin/displayName.md new file mode 100644 index 0000000..66b032e --- /dev/null +++ b/services/storage/v1/operations/delete-folder-from-recycle-bin/displayName.md @@ -0,0 +1 @@ +Delete folder from recycle bin \ No newline at end of file diff --git a/services/storage/v1/operations/delete-folder/description.md b/services/storage/v1/operations/delete-folder/description.md new file mode 100644 index 0000000..0e10877 --- /dev/null +++ b/services/storage/v1/operations/delete-folder/description.md @@ -0,0 +1,13 @@ +--- + +Delete a folder + +### Notes + +Folder moved to the recycle bin will be completely removed after 30 days. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/delete-folder/displayName.md b/services/storage/v1/operations/delete-folder/displayName.md new file mode 100644 index 0000000..ae49045 --- /dev/null +++ b/services/storage/v1/operations/delete-folder/displayName.md @@ -0,0 +1 @@ +Delete folder \ No newline at end of file diff --git a/services/storage/v1/operations/download-file/description.md b/services/storage/v1/operations/download-file/description.md new file mode 100644 index 0000000..1a6388a --- /dev/null +++ b/services/storage/v1/operations/download-file/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves file + +### Notes + +This endpoint returns 302 status code with Location header, which on success contains a link to the file. Redirection is not supported by developer portal and an error could be returned while using the "Try it" feature for this API. However, this endpoint will work if a request is sent from a different http client or by using the link specified in the response Location header. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/download-file/displayName.md b/services/storage/v1/operations/download-file/displayName.md new file mode 100644 index 0000000..3170dd3 --- /dev/null +++ b/services/storage/v1/operations/download-file/displayName.md @@ -0,0 +1 @@ +Download file \ No newline at end of file diff --git a/services/storage/v1/operations/get-file/description.md b/services/storage/v1/operations/get-file/description.md new file mode 100644 index 0000000..6674125 --- /dev/null +++ b/services/storage/v1/operations/get-file/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves file + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/get-file/displayName.md b/services/storage/v1/operations/get-file/displayName.md new file mode 100644 index 0000000..3c577cd --- /dev/null +++ b/services/storage/v1/operations/get-file/displayName.md @@ -0,0 +1 @@ +Get file \ No newline at end of file diff --git a/services/storage/v1/operations/get-files-in-folder/description.md b/services/storage/v1/operations/get-files-in-folder/description.md new file mode 100644 index 0000000..2e8598c --- /dev/null +++ b/services/storage/v1/operations/get-files-in-folder/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves files + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/get-files-in-folder/displayName.md b/services/storage/v1/operations/get-files-in-folder/displayName.md new file mode 100644 index 0000000..34aaecb --- /dev/null +++ b/services/storage/v1/operations/get-files-in-folder/displayName.md @@ -0,0 +1 @@ +Get files in folder \ No newline at end of file diff --git a/services/storage/v1/operations/get-folder/description.md b/services/storage/v1/operations/get-folder/description.md new file mode 100644 index 0000000..8366262 --- /dev/null +++ b/services/storage/v1/operations/get-folder/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves folder + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/get-folder/displayName.md b/services/storage/v1/operations/get-folder/displayName.md new file mode 100644 index 0000000..0668a63 --- /dev/null +++ b/services/storage/v1/operations/get-folder/displayName.md @@ -0,0 +1 @@ +Get folder \ No newline at end of file diff --git a/services/storage/v1/operations/get-folders-and-files-in-folder/description.md b/services/storage/v1/operations/get-folders-and-files-in-folder/description.md new file mode 100644 index 0000000..39db3d3 --- /dev/null +++ b/services/storage/v1/operations/get-folders-and-files-in-folder/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves files and folders + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/get-folders-and-files-in-folder/displayName.md b/services/storage/v1/operations/get-folders-and-files-in-folder/displayName.md new file mode 100644 index 0000000..40cbe6e --- /dev/null +++ b/services/storage/v1/operations/get-folders-and-files-in-folder/displayName.md @@ -0,0 +1 @@ +Get folders and files in folder \ No newline at end of file diff --git a/services/storage/v1/operations/get-folders-and-files-in-recycle-bin/description.md b/services/storage/v1/operations/get-folders-and-files-in-recycle-bin/description.md new file mode 100644 index 0000000..e418a27 --- /dev/null +++ b/services/storage/v1/operations/get-folders-and-files-in-recycle-bin/description.md @@ -0,0 +1,9 @@ +--- + +Get deleted files and folders + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/get-folders-and-files-in-recycle-bin/displayName.md b/services/storage/v1/operations/get-folders-and-files-in-recycle-bin/displayName.md new file mode 100644 index 0000000..aff0783 --- /dev/null +++ b/services/storage/v1/operations/get-folders-and-files-in-recycle-bin/displayName.md @@ -0,0 +1 @@ +Get folders and files in recycle bin \ No newline at end of file diff --git a/services/storage/v1/operations/get-folders-in-folder/description.md b/services/storage/v1/operations/get-folders-in-folder/description.md new file mode 100644 index 0000000..f9df768 --- /dev/null +++ b/services/storage/v1/operations/get-folders-in-folder/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves folders + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/get-folders-in-folder/displayName.md b/services/storage/v1/operations/get-folders-in-folder/displayName.md new file mode 100644 index 0000000..ad099f3 --- /dev/null +++ b/services/storage/v1/operations/get-folders-in-folder/displayName.md @@ -0,0 +1 @@ +Get folders in folder \ No newline at end of file diff --git a/services/storage/v1/operations/get-top-level-folders-and-files-by-project/description.md b/services/storage/v1/operations/get-top-level-folders-and-files-by-project/description.md new file mode 100644 index 0000000..92c6af6 --- /dev/null +++ b/services/storage/v1/operations/get-top-level-folders-and-files-by-project/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves top level files and folders by project + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/get-top-level-folders-and-files-by-project/displayName.md b/services/storage/v1/operations/get-top-level-folders-and-files-by-project/displayName.md new file mode 100644 index 0000000..25fd07c --- /dev/null +++ b/services/storage/v1/operations/get-top-level-folders-and-files-by-project/displayName.md @@ -0,0 +1 @@ +Get top level folders and files by project \ No newline at end of file diff --git a/services/storage/v1/operations/lock-files-in-folder/description.md b/services/storage/v1/operations/lock-files-in-folder/description.md new file mode 100644 index 0000000..0a52102 --- /dev/null +++ b/services/storage/v1/operations/lock-files-in-folder/description.md @@ -0,0 +1,9 @@ +--- + +Lock Files in Folder + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/lock-files-in-folder/displayName.md b/services/storage/v1/operations/lock-files-in-folder/displayName.md new file mode 100644 index 0000000..5211c37 --- /dev/null +++ b/services/storage/v1/operations/lock-files-in-folder/displayName.md @@ -0,0 +1 @@ +Lock files in folder \ No newline at end of file diff --git a/services/storage/v1/operations/move-file-legacy/description.md b/services/storage/v1/operations/move-file-legacy/description.md new file mode 100644 index 0000000..88a4cd9 --- /dev/null +++ b/services/storage/v1/operations/move-file-legacy/description.md @@ -0,0 +1,9 @@ +--- + +**This endpoint is on deprecation path, please use the correct [Move File](../move-file) endpoint instead.** + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/storage/v1/operations/move-file-legacy/displayName.md b/services/storage/v1/operations/move-file-legacy/displayName.md new file mode 100644 index 0000000..73e4fe5 --- /dev/null +++ b/services/storage/v1/operations/move-file-legacy/displayName.md @@ -0,0 +1 @@ +Move file (legacy) \ No newline at end of file diff --git a/services/storage/v1/operations/move-file/description.md b/services/storage/v1/operations/move-file/description.md new file mode 100644 index 0000000..5990b63 --- /dev/null +++ b/services/storage/v1/operations/move-file/description.md @@ -0,0 +1,9 @@ +--- + +Move file + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/storage/v1/operations/move-file/displayName.md b/services/storage/v1/operations/move-file/displayName.md new file mode 100644 index 0000000..182bb08 --- /dev/null +++ b/services/storage/v1/operations/move-file/displayName.md @@ -0,0 +1 @@ +Move file \ No newline at end of file diff --git a/services/storage/v1/operations/move-folder/description.md b/services/storage/v1/operations/move-folder/description.md new file mode 100644 index 0000000..9da6614 --- /dev/null +++ b/services/storage/v1/operations/move-folder/description.md @@ -0,0 +1,9 @@ +--- + +Move folder + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- diff --git a/services/storage/v1/operations/move-folder/displayName.md b/services/storage/v1/operations/move-folder/displayName.md new file mode 100644 index 0000000..6167afe --- /dev/null +++ b/services/storage/v1/operations/move-folder/displayName.md @@ -0,0 +1 @@ +Move folder \ No newline at end of file diff --git a/services/storage/v1/operations/restore-file/description.md b/services/storage/v1/operations/restore-file/description.md new file mode 100644 index 0000000..69c5a72 --- /dev/null +++ b/services/storage/v1/operations/restore-file/description.md @@ -0,0 +1,9 @@ +--- + +Restore deleted file from the recycle bin + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/restore-file/displayName.md b/services/storage/v1/operations/restore-file/displayName.md new file mode 100644 index 0000000..f459d7f --- /dev/null +++ b/services/storage/v1/operations/restore-file/displayName.md @@ -0,0 +1 @@ +Restore file \ No newline at end of file diff --git a/services/storage/v1/operations/restore-folder/description.md b/services/storage/v1/operations/restore-folder/description.md new file mode 100644 index 0000000..f35f20b --- /dev/null +++ b/services/storage/v1/operations/restore-folder/description.md @@ -0,0 +1,9 @@ +--- + +Restore deleted folder from the recycle bin + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/restore-folder/displayName.md b/services/storage/v1/operations/restore-folder/displayName.md new file mode 100644 index 0000000..23cad80 --- /dev/null +++ b/services/storage/v1/operations/restore-folder/displayName.md @@ -0,0 +1 @@ +Restore folder \ No newline at end of file diff --git a/services/storage/v1/operations/search-for-folders-and-files-in-folder/description.md b/services/storage/v1/operations/search-for-folders-and-files-in-folder/description.md new file mode 100644 index 0000000..8f86a8e --- /dev/null +++ b/services/storage/v1/operations/search-for-folders-and-files-in-folder/description.md @@ -0,0 +1,13 @@ +--- + +Finds files and folders in folder by name + +### Notes + +This query supports wildcard characters in the name parameter + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/search-for-folders-and-files-in-folder/displayName.md b/services/storage/v1/operations/search-for-folders-and-files-in-folder/displayName.md new file mode 100644 index 0000000..7a4adfc --- /dev/null +++ b/services/storage/v1/operations/search-for-folders-and-files-in-folder/displayName.md @@ -0,0 +1 @@ +Search for folders and files in folder \ No newline at end of file diff --git a/services/storage/v1/operations/unlock-files-in-folder/description.md b/services/storage/v1/operations/unlock-files-in-folder/description.md new file mode 100644 index 0000000..8407eaf --- /dev/null +++ b/services/storage/v1/operations/unlock-files-in-folder/description.md @@ -0,0 +1,9 @@ +--- + +Unlock files in folder + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/unlock-files-in-folder/displayName.md b/services/storage/v1/operations/unlock-files-in-folder/displayName.md new file mode 100644 index 0000000..f93a6a7 --- /dev/null +++ b/services/storage/v1/operations/unlock-files-in-folder/displayName.md @@ -0,0 +1 @@ +Unlock files in folder \ No newline at end of file diff --git a/services/storage/v1/operations/update-file-content/description.md b/services/storage/v1/operations/update-file-content/description.md new file mode 100644 index 0000000..cd80fbc --- /dev/null +++ b/services/storage/v1/operations/update-file-content/description.md @@ -0,0 +1,16 @@ +--- + +Update file's content + +### Notes + +File update is three steps operation. This request creates hyperlinks for file content update and confirmation. Next two requests need to be executed by using links from the response. Maximum file size to upload with single request is **256 MiB**. If bigger files needs to uploaded there are possibility to use Azure libraries or by uploading file with [multiple requests](https://docs.microsoft.com/en-us/rest/api/storageservices/operations-on-block-blobs). + +- **uploadUrl** is required for file upload. Upload can be done by sending http request and specifying x-ms-blob-type header to BlockBlob. +- **completeUrl** should be used to confirm file upload and it is final request for file creation. + +{!Authorization.md!} + +{!RbacPermissions.md!} + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/update-file-content/displayName.md b/services/storage/v1/operations/update-file-content/displayName.md new file mode 100644 index 0000000..7b71fbb --- /dev/null +++ b/services/storage/v1/operations/update-file-content/displayName.md @@ -0,0 +1 @@ +Update file content \ No newline at end of file diff --git a/services/storage/v1/operations/update-file/description.md b/services/storage/v1/operations/update-file/description.md new file mode 100644 index 0000000..fdfed93 --- /dev/null +++ b/services/storage/v1/operations/update-file/description.md @@ -0,0 +1,17 @@ +--- + +Update file + +{!Authorization.md!} + +{!RbacPermissions.md!} + +### Errors + +This request can return InvalidCreateFileRequest error with 422 status code. This could happen because of these reasons: + +- File name contains invalid characters. +- File name's length is larger than 255 characters. +- File could be harmful. For example, executable files are not accepted. + +--- diff --git a/services/storage/v1/operations/update-file/displayName.md b/services/storage/v1/operations/update-file/displayName.md new file mode 100644 index 0000000..fc600b0 --- /dev/null +++ b/services/storage/v1/operations/update-file/displayName.md @@ -0,0 +1 @@ +Update file \ No newline at end of file diff --git a/services/storage/v1/operations/update-folder/description.md b/services/storage/v1/operations/update-folder/description.md new file mode 100644 index 0000000..f72ac93 --- /dev/null +++ b/services/storage/v1/operations/update-folder/description.md @@ -0,0 +1,16 @@ +--- + +Update folder + +{!Authorization.md!} + +{!RbacPermissions.md!} + +### Errors + +This request can return InvalidCreateFolderRequest error with 422 status code. This could happen because of these reasons: + +- Folder name contains invalid characters. +- Folder name's length is larger than 255 characters. + +--- \ No newline at end of file diff --git a/services/storage/v1/operations/update-folder/displayName.md b/services/storage/v1/operations/update-folder/displayName.md new file mode 100644 index 0000000..86279d7 --- /dev/null +++ b/services/storage/v1/operations/update-folder/displayName.md @@ -0,0 +1 @@ +Update folder \ No newline at end of file diff --git a/services/synchronization/v1/description.md b/services/synchronization/v1/description.md new file mode 100644 index 0000000..94757a9 --- /dev/null +++ b/services/synchronization/v1/description.md @@ -0,0 +1 @@ +iModel Connections API is a cloud-based synchronization API meant to synchronize the data in Input Files and iModels. It allows users to establish links from their design files to iModels, hosted in Bentley's iModelHub. Users can synchronize updates to their design files. \ No newline at end of file diff --git a/services/synchronization/v1/operations/add-manifest-connection-sourcefile/description.md b/services/synchronization/v1/operations/add-manifest-connection-sourcefile/description.md new file mode 100644 index 0000000..7fcfaf7 --- /dev/null +++ b/services/synchronization/v1/operations/add-manifest-connection-sourcefile/description.md @@ -0,0 +1,10 @@ +--- + +Add a new Manifest Source File to a Manifest Connection + +{!Authorization.md!} + +### Associated entities +SourceFile is added to a Connection. The reuqest path must contain a valid Connection ID + +--- diff --git a/services/synchronization/v1/operations/add-manifest-connection-sourcefile/displayName.md b/services/synchronization/v1/operations/add-manifest-connection-sourcefile/displayName.md new file mode 100644 index 0000000..af955ef --- /dev/null +++ b/services/synchronization/v1/operations/add-manifest-connection-sourcefile/displayName.md @@ -0,0 +1 @@ +Add ManifestConnection SourceFile \ No newline at end of file diff --git a/services/synchronization/v1/operations/add-storage-connection-sourcefile/description.md b/services/synchronization/v1/operations/add-storage-connection-sourcefile/description.md new file mode 100644 index 0000000..10b1c56 --- /dev/null +++ b/services/synchronization/v1/operations/add-storage-connection-sourcefile/description.md @@ -0,0 +1,10 @@ +--- + +Add a new Storage Source File to a Storage Connection + +{!Authorization.md!} + +### Associated entities +SourceFile is added to a Connection. The reuqest path must contain a valid Connection ID + +--- diff --git a/services/synchronization/v1/operations/add-storage-connection-sourcefile/displayName.md b/services/synchronization/v1/operations/add-storage-connection-sourcefile/displayName.md new file mode 100644 index 0000000..31b62bd --- /dev/null +++ b/services/synchronization/v1/operations/add-storage-connection-sourcefile/displayName.md @@ -0,0 +1 @@ +Add StorageConnection SourceFile \ No newline at end of file diff --git a/services/synchronization/v1/operations/create-connection-configuration/description.md b/services/synchronization/v1/operations/create-connection-configuration/description.md new file mode 100644 index 0000000..70378f1 --- /dev/null +++ b/services/synchronization/v1/operations/create-connection-configuration/description.md @@ -0,0 +1,55 @@ +--- + +Create a configuration that defines how data is processed and synced to iModels with the specific connection. + +### Configurations + +#### reclassifyDgnElements + +Enables connector to change the base class of an element if its current classification comes from the Generic schema. +The default value is false. + +If this configuration is set to true: + +- Every Generic element in the model will be re-processed, so expect a longer synchronization job. +- Elements that are derived from a BIS class will not be processed. +- Elements that did not change in the source file may appear modified in iModel if you use the Changed Elements API. +- Elements that changed will appear deleted and added in iModel if you use the Changed Elements API. +- Suggest setting this configuration with caution and per required run basis, not perpetual. + +Use case example: If you have been advised by Bentley support that the Connector has added additional support for your files' disciplines (e.g. additional BIS schema alignment), then this option should be enabled on the next run to opt-in to the updated alignment. + +#### ignoreDgnAttachments + +Enables skipping of all reference attachments. As a result, only the master file is synchronized into the iModel. Only applicable for .dgn and .dwg files. +The default value is false. + +A reference file could have a transform/ level override/ symbology override when attached through a master file. None of these settings will be available if the files are processed individually and could result in data not matching the intended design. + +#### enableSheetsAndDrawings + +Controls sheets and drawings synchronization. If enabled all sheet models and relayed drawings will be synchronized to an iModel. +The default value is false. + +#### enableC3dGraphsIn2dModel + +Enables the separation of 2D elements from 3D elements in the target iModel when using Civil Connector. The 2D elements will be inserted into a graph model, while the 3D elements will be kept in the spatial model. The default value is false. + +Standard AutoCAD 2D entities, such as MTEXT, LINE, POLYLINE, etc., laid on the XY plane in the model space, will be converted as 2D elements and inserted into the graph model. This feature flag does not impact alignments and their labels, which always stay in the spatial model. + +If the file contains only AutoCAD entities and no Civil3D entities or has Civil3D model entities but no 2D graphics, we suggest leaving this configuration as false. + +#### enableSheetIndex + +A sheet index is a centralized and structured collection of sheets in your WorkSet. Enabling this flag triggers processing of sheet index files from the associated workspace.The default value is false. + +Use case example: Sheet index can be useful in creating a construction document set. So a civil user might be interested in turning on this flag to get the content of the sheets he has configured. + +#### filterBySheetIndex + +A sheet index is a centralized and structured collection of sheets in your WorkSet. Enabling this flag limits (filters) the processing of sheets provided to the connector to the ones specified in the sheet index. The default value is false. + +Use case example: Sheet index can be useful in creating a construction document set. However, there could be large number of sheets present in the input set and the user may be only interested in the ones specified by the sheet index. Enabling this flag allows such filtering. +{!Authorization.md!} + +--- diff --git a/services/synchronization/v1/operations/create-connection-configuration/displayName.md b/services/synchronization/v1/operations/create-connection-configuration/displayName.md new file mode 100644 index 0000000..1405965 --- /dev/null +++ b/services/synchronization/v1/operations/create-connection-configuration/displayName.md @@ -0,0 +1 @@ +Create Connection Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/create-imodel-configuration/description.md b/services/synchronization/v1/operations/create-imodel-configuration/description.md new file mode 100644 index 0000000..5807737 --- /dev/null +++ b/services/synchronization/v1/operations/create-imodel-configuration/description.md @@ -0,0 +1,27 @@ +--- + +Create a configuration that defines how data is processed and synced to iModels in the specific iModel. + +### Configurations + +#### clampZExtent + +Enables a limit for the project Z extent maximum up to Mount Everest height (i.e.8849 meters). Works only when project extent in XY direction is defined for iModel. +The default value is false. + +Display performance can be adversely affected if source data is poorly aligned or contains elements far from the project's physical location. If files cannot be corrected, this configuration would help viewers to restrict the Z extent. + +Use case example: allows restricting viewport to the bounding box so that any arbitrary geometry far away from the actual design does not impact fitting the model to the viewport. + +#### overrideRvtReprojectionDistance + +Define distance in meters when to start ignoring .rvt file geo-location data and reprojecting graphics based on local iModel coordinates. +The default value is 0. + +Reprojection happens when the .rvt file and iModel have different geographic coordinate systems. If the distance between both GCS is bigger than the number provided with the flag, reprojection will be skipped, and no errors will be reported. Otherwise, reprojection will be applied. +This configuration will have no effect if Revit was the first file synchronized to an empty iModel. + +Use case example: no reprojection of Revit file is needed beyond some pre-defined radius. +{!Authorization.md!} + +--- diff --git a/services/synchronization/v1/operations/create-imodel-configuration/displayName.md b/services/synchronization/v1/operations/create-imodel-configuration/displayName.md new file mode 100644 index 0000000..4b3e600 --- /dev/null +++ b/services/synchronization/v1/operations/create-imodel-configuration/displayName.md @@ -0,0 +1 @@ +Create iModel Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/create-itwin-configuration/description.md b/services/synchronization/v1/operations/create-itwin-configuration/description.md new file mode 100644 index 0000000..a470275 --- /dev/null +++ b/services/synchronization/v1/operations/create-itwin-configuration/description.md @@ -0,0 +1,44 @@ +--- + +Create a configuration that defines how data is processed and synced to iModels in the specific iTwin. + +### Configurations + +#### uploadDgnRealityData + +Enables reality data upload to Reality Data API while synchronizing files to iModels, if .3sm, .3mx, .pod, or raster attachments are attached to CAD data. +The default value is true. + +Having this configuration set to true will trigger credit usage for Reality Data service. + +#### convertDgnTerrainModels + +Enables terrain model elements to be processed during dgn-based synchronizations. +The default value is false. + +#### squashIntermediateRevisions + +Enables the creation of a single Changeset for physical and drawing elements (2D, 3D) coming from all Source Files. Separate Changesets will be pushed for any schema or definition changes. +The default value is false. + +Use case example: minimize a linear timeline of the iModel changes. However, in this case, you would not be able to get information on individual Source File changes. + +#### convertDgnHyperModelingSections + +Enables displaying the 2D section graphics and annotations in the context of the 3D model. +The default value is true. + +Use case example: typical design files include hypermodels, and the intent is to expose such information in a viewer. Refer to the sample of how to navigate between the 2D and 3D views easily: [sample](https://www.itwinjs.org/sandboxes/iTwinPlatform/Hyper-modeling) + +#### skipRvtReprojection + +Ignores geo-location defined in .rvt file and overlaps the model at the local iModel coordinates. +The default value is false. + +This configuration will have no effect if Revit was the first file synchronized to an empty iModel. + +Use case example: multiple Revit files will need to be synchronized; if individual files are not aligned to the exact location, this configuration will bring all the models to the same place. However, we suggest enhancing the original design files with proper geographic coordinate systems before synchronization instead of using this configuration. + +{!Authorization.md!} + +--- diff --git a/services/synchronization/v1/operations/create-itwin-configuration/displayName.md b/services/synchronization/v1/operations/create-itwin-configuration/displayName.md new file mode 100644 index 0000000..22b9a98 --- /dev/null +++ b/services/synchronization/v1/operations/create-itwin-configuration/displayName.md @@ -0,0 +1 @@ +Create iTwin Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/create-manifest-connection-run/description.md b/services/synchronization/v1/operations/create-manifest-connection-run/description.md new file mode 100644 index 0000000..b49d3db --- /dev/null +++ b/services/synchronization/v1/operations/create-manifest-connection-run/description.md @@ -0,0 +1,12 @@ +--- + +Runs the specified ManifestConnection. + +### Notes + +When a run is successfully created, the operation returns HTTP status code 202/accepted - the request is accepted for processing and will execute in background. The response will include a location header pointing to the created run. If an existing active run already exists for the iModel, a new run is not initiated, instead 303/see other is returned along with location header pointing to that existing active run. +In the rare event that multiple create run requests are being made simultaneously, only the first request is processed and 409/conflict is returned for others. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/create-manifest-connection-run/displayName.md b/services/synchronization/v1/operations/create-manifest-connection-run/displayName.md new file mode 100644 index 0000000..3f74ee8 --- /dev/null +++ b/services/synchronization/v1/operations/create-manifest-connection-run/displayName.md @@ -0,0 +1 @@ +Create ManifestConnection Run \ No newline at end of file diff --git a/services/synchronization/v1/operations/create-manifest-connection/description.md b/services/synchronization/v1/operations/create-manifest-connection/description.md new file mode 100644 index 0000000..a953014 --- /dev/null +++ b/services/synchronization/v1/operations/create-manifest-connection/description.md @@ -0,0 +1,11 @@ +--- + +Create a ManifestConnection that describes which files from a manifest will be synchronized to the iModel. + +{!Authorization.md!} + +### Associated entities + +A connection is linked with an iModel. An iModel ID is required to be set when creating a ManifestConnection. + +--- diff --git a/services/synchronization/v1/operations/create-manifest-connection/displayName.md b/services/synchronization/v1/operations/create-manifest-connection/displayName.md new file mode 100644 index 0000000..bb29e3d --- /dev/null +++ b/services/synchronization/v1/operations/create-manifest-connection/displayName.md @@ -0,0 +1 @@ +Create ManifestConnection \ No newline at end of file diff --git a/services/synchronization/v1/operations/create-storage-connection/description.md b/services/synchronization/v1/operations/create-storage-connection/description.md new file mode 100644 index 0000000..d668d24 --- /dev/null +++ b/services/synchronization/v1/operations/create-storage-connection/description.md @@ -0,0 +1,11 @@ +--- + +Create a StorageConnection that describes files from Storage to synchronize to the iModel. + +{!Authorization.md!} + +### Associated entities + +A connection is linked with an iModel. An iModel ID is required to be set when creating a StorageConnection. + +--- diff --git a/services/synchronization/v1/operations/create-storage-connection/displayName.md b/services/synchronization/v1/operations/create-storage-connection/displayName.md new file mode 100644 index 0000000..abd86d6 --- /dev/null +++ b/services/synchronization/v1/operations/create-storage-connection/displayName.md @@ -0,0 +1 @@ +Create StorageConnection \ No newline at end of file diff --git a/services/synchronization/v1/operations/delete-connection-configuration/description.md b/services/synchronization/v1/operations/delete-connection-configuration/description.md new file mode 100644 index 0000000..ac2a422 --- /dev/null +++ b/services/synchronization/v1/operations/delete-connection-configuration/description.md @@ -0,0 +1,7 @@ +--- + +Delete a specified configuration based on the provided connection Id. + +{!Authorization.md!} + +--- diff --git a/services/synchronization/v1/operations/delete-connection-configuration/displayName.md b/services/synchronization/v1/operations/delete-connection-configuration/displayName.md new file mode 100644 index 0000000..b03b35c --- /dev/null +++ b/services/synchronization/v1/operations/delete-connection-configuration/displayName.md @@ -0,0 +1 @@ +Delete Connection Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/delete-imodel-configuration/description.md b/services/synchronization/v1/operations/delete-imodel-configuration/description.md new file mode 100644 index 0000000..192b8d5 --- /dev/null +++ b/services/synchronization/v1/operations/delete-imodel-configuration/description.md @@ -0,0 +1,7 @@ +--- + +Delete a specified configuration based on the provided iModel Id. + +{!Authorization.md!} + +--- diff --git a/services/synchronization/v1/operations/delete-imodel-configuration/displayName.md b/services/synchronization/v1/operations/delete-imodel-configuration/displayName.md new file mode 100644 index 0000000..b84cf8b --- /dev/null +++ b/services/synchronization/v1/operations/delete-imodel-configuration/displayName.md @@ -0,0 +1 @@ +Delete iModel Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/delete-itwin-configuration/description.md b/services/synchronization/v1/operations/delete-itwin-configuration/description.md new file mode 100644 index 0000000..c093a6a --- /dev/null +++ b/services/synchronization/v1/operations/delete-itwin-configuration/description.md @@ -0,0 +1,7 @@ +--- + +Delete a specified configuration based on the provided iTwin Id. + +{!Authorization.md!} + +--- diff --git a/services/synchronization/v1/operations/delete-itwin-configuration/displayName.md b/services/synchronization/v1/operations/delete-itwin-configuration/displayName.md new file mode 100644 index 0000000..2080eb5 --- /dev/null +++ b/services/synchronization/v1/operations/delete-itwin-configuration/displayName.md @@ -0,0 +1 @@ +Delete iTwin Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/delete-manifest-connection/description.md b/services/synchronization/v1/operations/delete-manifest-connection/description.md new file mode 100644 index 0000000..9b64b09 --- /dev/null +++ b/services/synchronization/v1/operations/delete-manifest-connection/description.md @@ -0,0 +1,8 @@ +--- + +Delete connection + +{!Authorization.md!} + + +--- diff --git a/services/synchronization/v1/operations/delete-manifest-connection/displayName.md b/services/synchronization/v1/operations/delete-manifest-connection/displayName.md new file mode 100644 index 0000000..d2d632a --- /dev/null +++ b/services/synchronization/v1/operations/delete-manifest-connection/displayName.md @@ -0,0 +1 @@ +Delete ManifestConnection \ No newline at end of file diff --git a/services/synchronization/v1/operations/delete-storage-connection/description.md b/services/synchronization/v1/operations/delete-storage-connection/description.md new file mode 100644 index 0000000..9b64b09 --- /dev/null +++ b/services/synchronization/v1/operations/delete-storage-connection/description.md @@ -0,0 +1,8 @@ +--- + +Delete connection + +{!Authorization.md!} + + +--- diff --git a/services/synchronization/v1/operations/delete-storage-connection/displayName.md b/services/synchronization/v1/operations/delete-storage-connection/displayName.md new file mode 100644 index 0000000..f0cd46c --- /dev/null +++ b/services/synchronization/v1/operations/delete-storage-connection/displayName.md @@ -0,0 +1 @@ +Delete StorageConnection \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-authorization-information/description.md b/services/synchronization/v1/operations/get-authorization-information/description.md new file mode 100644 index 0000000..6138771 --- /dev/null +++ b/services/synchronization/v1/operations/get-authorization-information/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves the calling user's AuthorizationInformation. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-authorization-information/displayName.md b/services/synchronization/v1/operations/get-authorization-information/displayName.md new file mode 100644 index 0000000..a6bf805 --- /dev/null +++ b/services/synchronization/v1/operations/get-authorization-information/displayName.md @@ -0,0 +1 @@ +Get AuthorizationInformation \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-connection-configuration/description.md b/services/synchronization/v1/operations/get-connection-configuration/description.md new file mode 100644 index 0000000..4697fb2 --- /dev/null +++ b/services/synchronization/v1/operations/get-connection-configuration/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a configuration based on the provided connection Id. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-connection-configuration/displayName.md b/services/synchronization/v1/operations/get-connection-configuration/displayName.md new file mode 100644 index 0000000..4d68020 --- /dev/null +++ b/services/synchronization/v1/operations/get-connection-configuration/displayName.md @@ -0,0 +1 @@ +Get Connection Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-connections/description.md b/services/synchronization/v1/operations/get-connections/description.md new file mode 100644 index 0000000..d9966a3 --- /dev/null +++ b/services/synchronization/v1/operations/get-connections/description.md @@ -0,0 +1,16 @@ +--- + +Retrieves connections for the specified iModel. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-connections/displayName.md b/services/synchronization/v1/operations/get-connections/displayName.md new file mode 100644 index 0000000..05cf75f --- /dev/null +++ b/services/synchronization/v1/operations/get-connections/displayName.md @@ -0,0 +1 @@ +Get Connections \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-imodel-configuration/description.md b/services/synchronization/v1/operations/get-imodel-configuration/description.md new file mode 100644 index 0000000..a713fab --- /dev/null +++ b/services/synchronization/v1/operations/get-imodel-configuration/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a configuration based on the provided iModel Id. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-imodel-configuration/displayName.md b/services/synchronization/v1/operations/get-imodel-configuration/displayName.md new file mode 100644 index 0000000..836e42f --- /dev/null +++ b/services/synchronization/v1/operations/get-imodel-configuration/displayName.md @@ -0,0 +1 @@ +Get iModel Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-itwin-configuration/description.md b/services/synchronization/v1/operations/get-itwin-configuration/description.md new file mode 100644 index 0000000..202efd5 --- /dev/null +++ b/services/synchronization/v1/operations/get-itwin-configuration/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a configuration based on the provided iTwin Id. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-itwin-configuration/displayName.md b/services/synchronization/v1/operations/get-itwin-configuration/displayName.md new file mode 100644 index 0000000..8f8af93 --- /dev/null +++ b/services/synchronization/v1/operations/get-itwin-configuration/displayName.md @@ -0,0 +1 @@ +Get iTwin Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-manifest-connection-run/description.md b/services/synchronization/v1/operations/get-manifest-connection-run/description.md new file mode 100644 index 0000000..3602317 --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connection-run/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a ManifestConnection Run with the specified ID. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-manifest-connection-run/displayName.md b/services/synchronization/v1/operations/get-manifest-connection-run/displayName.md new file mode 100644 index 0000000..d0fcdc8 --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connection-run/displayName.md @@ -0,0 +1 @@ +Get ManifestConnection Run \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-manifest-connection-runs/description.md b/services/synchronization/v1/operations/get-manifest-connection-runs/description.md new file mode 100644 index 0000000..4899d53 --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connection-runs/description.md @@ -0,0 +1,16 @@ +--- + +Retrieves all Runs for the specified connection. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-manifest-connection-runs/displayName.md b/services/synchronization/v1/operations/get-manifest-connection-runs/displayName.md new file mode 100644 index 0000000..eb7cdf1 --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connection-runs/displayName.md @@ -0,0 +1 @@ +Get ManifestConnection Runs \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-manifest-connection-sourcefile/description.md b/services/synchronization/v1/operations/get-manifest-connection-sourcefile/description.md new file mode 100644 index 0000000..d8bd998 --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connection-sourcefile/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves ManifestConnection's SourceFile with the specified ID. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-manifest-connection-sourcefile/displayName.md b/services/synchronization/v1/operations/get-manifest-connection-sourcefile/displayName.md new file mode 100644 index 0000000..2944d70 --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connection-sourcefile/displayName.md @@ -0,0 +1 @@ +Get ManifestConnection SourceFile \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-manifest-connection-sourcefiles/description.md b/services/synchronization/v1/operations/get-manifest-connection-sourcefiles/description.md new file mode 100644 index 0000000..074a229 --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connection-sourcefiles/description.md @@ -0,0 +1,16 @@ +--- + +Retrieves SourceFiles for specified ManifestConnection. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-manifest-connection-sourcefiles/displayName.md b/services/synchronization/v1/operations/get-manifest-connection-sourcefiles/displayName.md new file mode 100644 index 0000000..584ff93 --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connection-sourcefiles/displayName.md @@ -0,0 +1 @@ +Get ManifestConnection SourceFiles \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-manifest-connection/description.md b/services/synchronization/v1/operations/get-manifest-connection/description.md new file mode 100644 index 0000000..8b0f4d0 --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connection/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a ManifestConnection with the specified ID. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-manifest-connection/displayName.md b/services/synchronization/v1/operations/get-manifest-connection/displayName.md new file mode 100644 index 0000000..dab0f46 --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connection/displayName.md @@ -0,0 +1 @@ +Get ManifestConnection \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-manifest-connections/description.md b/services/synchronization/v1/operations/get-manifest-connections/description.md new file mode 100644 index 0000000..631862c --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connections/description.md @@ -0,0 +1,16 @@ +--- + +Retrieves Manifest Connections for the specified iModel. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +--- diff --git a/services/synchronization/v1/operations/get-manifest-connections/displayName.md b/services/synchronization/v1/operations/get-manifest-connections/displayName.md new file mode 100644 index 0000000..e983ebf --- /dev/null +++ b/services/synchronization/v1/operations/get-manifest-connections/displayName.md @@ -0,0 +1 @@ +Get ManifestConnections \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-storage-connection-run/description.md b/services/synchronization/v1/operations/get-storage-connection-run/description.md new file mode 100644 index 0000000..28a2c52 --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connection-run/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a StorageConnection Run with the specified ID. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-storage-connection-run/displayName.md b/services/synchronization/v1/operations/get-storage-connection-run/displayName.md new file mode 100644 index 0000000..bb04d3f --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connection-run/displayName.md @@ -0,0 +1 @@ +Get StorageConnection Run \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-storage-connection-runs/description.md b/services/synchronization/v1/operations/get-storage-connection-runs/description.md new file mode 100644 index 0000000..4899d53 --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connection-runs/description.md @@ -0,0 +1,16 @@ +--- + +Retrieves all Runs for the specified connection. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-storage-connection-runs/displayName.md b/services/synchronization/v1/operations/get-storage-connection-runs/displayName.md new file mode 100644 index 0000000..e1e134a --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connection-runs/displayName.md @@ -0,0 +1 @@ +Get StorageConnection Runs \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-storage-connection-sourcefile/description.md b/services/synchronization/v1/operations/get-storage-connection-sourcefile/description.md new file mode 100644 index 0000000..06cd272 --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connection-sourcefile/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves StorageConnection's SourceFile with the specified ID. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-storage-connection-sourcefile/displayName.md b/services/synchronization/v1/operations/get-storage-connection-sourcefile/displayName.md new file mode 100644 index 0000000..608667c --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connection-sourcefile/displayName.md @@ -0,0 +1 @@ +Get StorageConnection SourceFile \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-storage-connection-sourcefiles/description.md b/services/synchronization/v1/operations/get-storage-connection-sourcefiles/description.md new file mode 100644 index 0000000..fedbf61 --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connection-sourcefiles/description.md @@ -0,0 +1,16 @@ +--- + +Retrieves SourceFiles for specified StorageConnection. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-storage-connection-sourcefiles/displayName.md b/services/synchronization/v1/operations/get-storage-connection-sourcefiles/displayName.md new file mode 100644 index 0000000..05371dd --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connection-sourcefiles/displayName.md @@ -0,0 +1 @@ +Get StorageConnection SourceFiles \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-storage-connection/description.md b/services/synchronization/v1/operations/get-storage-connection/description.md new file mode 100644 index 0000000..af25e90 --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connection/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a StorageConnection with the specified ID. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-storage-connection/displayName.md b/services/synchronization/v1/operations/get-storage-connection/displayName.md new file mode 100644 index 0000000..f0df9d5 --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connection/displayName.md @@ -0,0 +1 @@ +Get StorageConnection \ No newline at end of file diff --git a/services/synchronization/v1/operations/get-storage-connections/description.md b/services/synchronization/v1/operations/get-storage-connections/description.md new file mode 100644 index 0000000..e079c79 --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connections/description.md @@ -0,0 +1,16 @@ +--- + +Retrieves Storage Connections for the specified iModel. + +### Notes + +The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. + +This operation supports `"return=representation"` and `"return=minimal"` preferences. + +The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. +The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified. + +{!Authorization.md!} + +--- diff --git a/services/synchronization/v1/operations/get-storage-connections/displayName.md b/services/synchronization/v1/operations/get-storage-connections/displayName.md new file mode 100644 index 0000000..f08373d --- /dev/null +++ b/services/synchronization/v1/operations/get-storage-connections/displayName.md @@ -0,0 +1 @@ +Get StorageConnections \ No newline at end of file diff --git a/services/synchronization/v1/operations/patch-connection-configuration/description.md b/services/synchronization/v1/operations/patch-connection-configuration/description.md new file mode 100644 index 0000000..6a09884 --- /dev/null +++ b/services/synchronization/v1/operations/patch-connection-configuration/description.md @@ -0,0 +1,7 @@ +--- + +Patches a Configuration based on the provided connection Id. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/patch-connection-configuration/displayName.md b/services/synchronization/v1/operations/patch-connection-configuration/displayName.md new file mode 100644 index 0000000..c0eddff --- /dev/null +++ b/services/synchronization/v1/operations/patch-connection-configuration/displayName.md @@ -0,0 +1 @@ +Patch Connection Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/patch-imodel-configuration/description.md b/services/synchronization/v1/operations/patch-imodel-configuration/description.md new file mode 100644 index 0000000..03e9e0b --- /dev/null +++ b/services/synchronization/v1/operations/patch-imodel-configuration/description.md @@ -0,0 +1,7 @@ +--- + +Patches a configuration based on the provided iModel Id. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/patch-imodel-configuration/displayName.md b/services/synchronization/v1/operations/patch-imodel-configuration/displayName.md new file mode 100644 index 0000000..b727660 --- /dev/null +++ b/services/synchronization/v1/operations/patch-imodel-configuration/displayName.md @@ -0,0 +1 @@ +Patch iModel Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/patch-itwin-configuration/description.md b/services/synchronization/v1/operations/patch-itwin-configuration/description.md new file mode 100644 index 0000000..e93b8bc --- /dev/null +++ b/services/synchronization/v1/operations/patch-itwin-configuration/description.md @@ -0,0 +1,7 @@ +--- + +Patches a configuration based on the provided iTwin Id. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/patch-itwin-configuration/displayName.md b/services/synchronization/v1/operations/patch-itwin-configuration/displayName.md new file mode 100644 index 0000000..a044fe0 --- /dev/null +++ b/services/synchronization/v1/operations/patch-itwin-configuration/displayName.md @@ -0,0 +1 @@ +Patch iTwin Configurations \ No newline at end of file diff --git a/services/synchronization/v1/operations/remove-manifest-connection-sourcefile/description.md b/services/synchronization/v1/operations/remove-manifest-connection-sourcefile/description.md new file mode 100644 index 0000000..01a8c19 --- /dev/null +++ b/services/synchronization/v1/operations/remove-manifest-connection-sourcefile/description.md @@ -0,0 +1,8 @@ +--- + +Delete ManifestConnection SourceFile + +{!Authorization.md!} + + +--- diff --git a/services/synchronization/v1/operations/remove-manifest-connection-sourcefile/displayName.md b/services/synchronization/v1/operations/remove-manifest-connection-sourcefile/displayName.md new file mode 100644 index 0000000..961d1e1 --- /dev/null +++ b/services/synchronization/v1/operations/remove-manifest-connection-sourcefile/displayName.md @@ -0,0 +1 @@ +Remove ManifestConnection SourceFile \ No newline at end of file diff --git a/services/synchronization/v1/operations/remove-storage-connection-sourcefile/description.md b/services/synchronization/v1/operations/remove-storage-connection-sourcefile/description.md new file mode 100644 index 0000000..7145a52 --- /dev/null +++ b/services/synchronization/v1/operations/remove-storage-connection-sourcefile/description.md @@ -0,0 +1,8 @@ +--- + +Delete StorageConnection SourceFile + +{!Authorization.md!} + + +--- diff --git a/services/synchronization/v1/operations/remove-storage-connection-sourcefile/displayName.md b/services/synchronization/v1/operations/remove-storage-connection-sourcefile/displayName.md new file mode 100644 index 0000000..d81be2c --- /dev/null +++ b/services/synchronization/v1/operations/remove-storage-connection-sourcefile/displayName.md @@ -0,0 +1 @@ +Remove StorageConnection SourceFile \ No newline at end of file diff --git a/services/synchronization/v1/operations/run-storage-connection/description.md b/services/synchronization/v1/operations/run-storage-connection/description.md new file mode 100644 index 0000000..c035e64 --- /dev/null +++ b/services/synchronization/v1/operations/run-storage-connection/description.md @@ -0,0 +1,12 @@ +--- + +Runs the specified StorageConnection. + +### Notes + +When a run is successfully created, the operation returns HTTP status code 202/accepted - the request is accepted for processing and will execute in background. The response will include a location header pointing to the created run. If an existing active run already exists for the iModel, a new run is not initiated, instead 303/see other is returned along with location header pointing to that existing active run. +In the rare event that multiple create run requests are being made simultaneously, only the first request is processed and 409/conflict is returned for others. + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/synchronization/v1/operations/run-storage-connection/displayName.md b/services/synchronization/v1/operations/run-storage-connection/displayName.md new file mode 100644 index 0000000..d1d047f --- /dev/null +++ b/services/synchronization/v1/operations/run-storage-connection/displayName.md @@ -0,0 +1 @@ +Create StorageConnection Run \ No newline at end of file diff --git a/services/synchronization/v1/operations/update-manifest-connection-sourcefile/description.md b/services/synchronization/v1/operations/update-manifest-connection-sourcefile/description.md new file mode 100644 index 0000000..7cad14b --- /dev/null +++ b/services/synchronization/v1/operations/update-manifest-connection-sourcefile/description.md @@ -0,0 +1,10 @@ +--- + +Update an existing StorageConnection SourceFile. + +{!Authorization.md!} + +### Associated entities +SourceFile is related to a Connection. The path must contain a valid Connection ID. + +--- diff --git a/services/synchronization/v1/operations/update-manifest-connection-sourcefile/displayName.md b/services/synchronization/v1/operations/update-manifest-connection-sourcefile/displayName.md new file mode 100644 index 0000000..92904e6 --- /dev/null +++ b/services/synchronization/v1/operations/update-manifest-connection-sourcefile/displayName.md @@ -0,0 +1 @@ +Update ManifestConnection SourceFile \ No newline at end of file diff --git a/services/synchronization/v1/operations/update-manifest-connection/description.md b/services/synchronization/v1/operations/update-manifest-connection/description.md new file mode 100644 index 0000000..ae04b33 --- /dev/null +++ b/services/synchronization/v1/operations/update-manifest-connection/description.md @@ -0,0 +1,11 @@ +--- + +Update an existing ManifestConnection. + +{!Authorization.md!} + +### Associated entities + +The Connection ID is required to be set when updating a ManifestConnection. + +--- diff --git a/services/synchronization/v1/operations/update-manifest-connection/displayName.md b/services/synchronization/v1/operations/update-manifest-connection/displayName.md new file mode 100644 index 0000000..bac9f2a --- /dev/null +++ b/services/synchronization/v1/operations/update-manifest-connection/displayName.md @@ -0,0 +1 @@ +Update ManifestConnection \ No newline at end of file diff --git a/services/synchronization/v1/operations/update-storage-connection-sourcefile/description.md b/services/synchronization/v1/operations/update-storage-connection-sourcefile/description.md new file mode 100644 index 0000000..7cad14b --- /dev/null +++ b/services/synchronization/v1/operations/update-storage-connection-sourcefile/description.md @@ -0,0 +1,10 @@ +--- + +Update an existing StorageConnection SourceFile. + +{!Authorization.md!} + +### Associated entities +SourceFile is related to a Connection. The path must contain a valid Connection ID. + +--- diff --git a/services/synchronization/v1/operations/update-storage-connection-sourcefile/displayName.md b/services/synchronization/v1/operations/update-storage-connection-sourcefile/displayName.md new file mode 100644 index 0000000..372f7c1 --- /dev/null +++ b/services/synchronization/v1/operations/update-storage-connection-sourcefile/displayName.md @@ -0,0 +1 @@ +Update StorageConnection SourceFile \ No newline at end of file diff --git a/services/synchronization/v1/operations/update-storage-connection/description.md b/services/synchronization/v1/operations/update-storage-connection/description.md new file mode 100644 index 0000000..ffa9667 --- /dev/null +++ b/services/synchronization/v1/operations/update-storage-connection/description.md @@ -0,0 +1,11 @@ +--- + +Update an existing StorageConnection. + +{!Authorization.md!} + +### Associated entities + +A connection is linked with an iModel. The iModel ID is required to be set when updating a StorageConnection. + +--- diff --git a/services/synchronization/v1/operations/update-storage-connection/displayName.md b/services/synchronization/v1/operations/update-storage-connection/displayName.md new file mode 100644 index 0000000..947bd6a --- /dev/null +++ b/services/synchronization/v1/operations/update-storage-connection/displayName.md @@ -0,0 +1 @@ +Update StorageConnection \ No newline at end of file diff --git a/services/transformations/v1/description.md b/services/transformations/v1/description.md new file mode 100644 index 0000000..4dbfa2e --- /dev/null +++ b/services/transformations/v1/description.md @@ -0,0 +1,3 @@ +iModel transformations service + +Perform transformations on iModels. diff --git a/services/transformations/v1/operations/alignimodeldata/description.md b/services/transformations/v1/operations/alignimodeldata/description.md new file mode 100644 index 0000000..3e14ec1 --- /dev/null +++ b/services/transformations/v1/operations/alignimodeldata/description.md @@ -0,0 +1,64 @@ +--- + +This endpoint is used to create a configuration for align iModel data transformation. + +Align iModel data transformation provides the capability of remapping element EClasses and their ECProperties, and performing modifications on **dynamic** ECSchemas. Dynamic schema modifications include the removal of unused ECClasses and merging multiple ECClasses into a single ECClass. + +Configuration specific properties explained: + +``` +schemaOptimizationOptions - options that will modify ECSchemas. + - removeUnusedClasses - if `true` ECClasses that have 0 elements will be removed from all **dynamic** ECSchemas. + - classMergingGroups - array of ECClass merging group objects. + - sourceECClasses - array of ECClass objects. Classes in this array will be merged into a single target ECClass. All class elements will also be remapped into the target ECClass. + - ecClassName - ECClass name. + - ecSchemaName - ECSchema name. + - targetECClass - target ECClass. all sourceECClasses will be merged into this ECClass. + - ecClassName - ECClass name. + - ecSchemaName - ECSchema name. +dataRemappingOptions - options for data remapping. + - additionalECSchemas - array of Bentley defined ECSchemas that will be imported into the target iModel + - ecSchemaName - ECSchema name. + - ecSchemaVersion - ECSchema version. + - elementGroups - array of element group objects. Each object in the array defines a collection of elements to be mapped into a single target ECClass. + - targetECClass - a target class for the elements selected by the `elementPropertyQuery` to be remapped into. + - ecClassName - ECClass name. + - ecSchemaName - ECSchema name. + - elementPropertyQuery - ECSql query that selects element ECInstanceIds and any additional properties. +``` + +### Target ECClass + +If `targetECClass` does not exist in the source iModel its schema must be imported using the `additionalECSchemas` property. + +### Element Property query + +The `elementPropertyQuery` must be a valid ECSql statement. The only requirement for the query is that it must select ECInstanceId column. Elements with these ids will be remapped into the `targetECClass`. Any additional column the query returns is treated as an additional property. Given that the additional property's column name and an ECProperty in the `targetECClass` name match, its value will be carried through and will be exported as that ECProperty's value in the target iModel. Column names for ECProperties are case insensitive. + +#### Example + +`ArchitecturalPhysical.Door` ECClass has 3 ECProperties defined - `OverallHeight`, `OverallWidth` and `Description`. To remap all `Generic.PhysicalObject` elements that have "door" in their UserLabel to an `ArchitecturalPhysical.Door` ECClass, a valid `elementPropertyQuery` would be: +- `SELECT ECInstanceId, 'This element was remapped from PhysicalObject' as Description, 15 as OverallHeight FROM Generic.PhysicalObject WHERE UserLabel LIKE '%door%'` + +Remapped elements in the target iModel would have the following properties: +- Description: 'This element was remapped from PhysicalObject' +- OverallHeight: 15 +- OverallWidth: NULL +- ... + +Original properties will be carried through from the original element and any properties that do not exist in the target class will be lost. + +To change already existing element property, select an already existing column. The following query will change all `BisCore.PhysicalObject` class element's user labels to 'Updated user label': +`SELECT ECInstanceId, 'Updated user label' as UserLabel FROM Generic.PhysicalObject` + +{!TransformerMetadata.md!} + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/alignimodeldata/displayName.md b/services/transformations/v1/operations/alignimodeldata/displayName.md new file mode 100644 index 0000000..7a086cb --- /dev/null +++ b/services/transformations/v1/operations/alignimodeldata/displayName.md @@ -0,0 +1 @@ +AlignIModelData \ No newline at end of file diff --git a/services/transformations/v1/operations/combineimodels/description.md b/services/transformations/v1/operations/combineimodels/description.md new file mode 100644 index 0000000..283f94a --- /dev/null +++ b/services/transformations/v1/operations/combineimodels/description.md @@ -0,0 +1,54 @@ +--- + +This endpoint is used to create CombineIModels configuration. + +Combine IModels transformation combines the source iModel with iModels provided in transformation parameters. +This is done by importing each source iModel into the target iModel sequentially. IModels are imported into the target in the same order that they were provided in (`configuration.sourceIModel`, `configuration.transformParameters.iModels[0]`, `configuration.transformParameters.iModels[1]`, etc.). + +For every source iModel a `BisCore:Subject` is created in the target iModel. Each source iModel's contents are exported under their corresponding subject in the target. Subjects are named after their source iModels. Any possible naming conflicts are resolved by appending a number to the subject's name if needed (ex. `Duplicate name 2`). + +Also, a new definition partition is created under new subject to persist all ViewDefinitions from source iModels, even if they have conflicting codes. This means that all ViewAttachment, ViewDefinition, ModelSelector, DisplayStyle and CategorySelector elements that are scoped under the dictionary model (id '0x10'), will be remapped under this newly created definition partition. + +Element conflicts can occur when merging iModels (e.g. 2 subCategories with the same Element Code have different appearance props). +In this case, every iModel in the import chain will keep overwriting the conflicting element effectively preserving the last value that was found. This means that the last iModel in the `transformParameters.iModels` list will take precedence. +Only elements whose scoping hierarchy ultimately reaches elements with ids `0x10` (dictionaryId) and `0xe` will be able to conflict with each other (most common cases are `DefinitionElement`s). Any other elements that are ultimately scoped by the root subject will be imported under a new subject as mentioned above and cannot conflict (because their scope becomes unique). + +The first Geo location that is found will be applied onto the target iModel. +For example, if merging three iModels in this order: + +1. `iModel A` (not geo located) +2. `iModel B` (geo location is `BB`) +3. `iModel C` (geo location is `CC`) + +Target iModel will have geo location set to `BB`. + +Configuration specific properties explained: +``` +iModels - list of iModels to combine the source iModel with. + - iModelId - id of iModel + - projectId - id of project that iModel belongs to +``` +
+ +**Limitations**: This API does not support combining iModels that have conflicting dynamic ECSchemas. +Conflicting ECSchemas are two ECSchemas that have the same name, but have at least one difference such as: + different aliases or any difference between EC object items ([EC schema contents](https://www.itwinjs.org/bis/ec/)). + For example, "CustomSchema" in iModel "A" has an ECClass "MyClass", while "CustomSchema" in iModel "B" doesn't have + an ECClass "MyClass". + +In case of ECSchema conflict, transformation will fail with an error message. Those error messages +might vary depending on the conflict that was encountered. Transformation status and +it's error message can be retrieved by sending +[GET transformation](/apis/transformations/operations/get-transformation/) request. + +{!TransformerMetadata.md!} + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/combineimodels/displayName.md b/services/transformations/v1/operations/combineimodels/displayName.md new file mode 100644 index 0000000..82ecf21 --- /dev/null +++ b/services/transformations/v1/operations/combineimodels/displayName.md @@ -0,0 +1 @@ +CombineIModels \ No newline at end of file diff --git a/services/transformations/v1/operations/combinephysicalmodels/description.md b/services/transformations/v1/operations/combinephysicalmodels/description.md new file mode 100644 index 0000000..b186250 --- /dev/null +++ b/services/transformations/v1/operations/combinephysicalmodels/description.md @@ -0,0 +1,28 @@ +--- + +This endpoint is used to create Combine Physical Models configuration. + +Combine Physical Models transformation combines the source iModel's top level hierarchy physical models to a desired amount of models. +For more information see [iModel Information Hierarchy](https://www.itwinjs.org/bis/guide/data-organization/information-hierarchy/#example-information-hierarchy). + +This transformation is usually leveraged to improve performance of iModel viewers. Lack of performance is noticeable when model counts reach ~1000 or even more models. +It is recommended you set the `numberOfModels` property to ~ 5-20 and test the performance of the iModel. + +Configuration specific properties explained: +``` +numberOfModels - specify amount of models to transform the source iModel into. +simplifyGeometry - optional parameter indicating if geometry simplification should be used (transforming parasolids to meshes). Default if not specified - false. +``` +
+ +{!TransformerMetadata.md!} + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/combinephysicalmodels/displayName.md b/services/transformations/v1/operations/combinephysicalmodels/displayName.md new file mode 100644 index 0000000..793baac --- /dev/null +++ b/services/transformations/v1/operations/combinephysicalmodels/displayName.md @@ -0,0 +1 @@ +CombinePhysicalModels \ No newline at end of file diff --git a/services/transformations/v1/operations/combinephysicalmodelsv2/description.md b/services/transformations/v1/operations/combinephysicalmodelsv2/description.md new file mode 100644 index 0000000..580d570 --- /dev/null +++ b/services/transformations/v1/operations/combinephysicalmodelsv2/description.md @@ -0,0 +1,30 @@ +--- + +Use this endpoint to create CombinePhysicalModelsV2 configuration. + +Combine Physical Models V2 transformation combines models in source iModel based on the EC query into target physical models with specified names. It is mandatory to only create source model queries which select ECInstanceId by using `*` or explicitly selecting that column. Also, source queries must pick only physical models that are sub-modeling physical partition. +For more information about internal iModel structure, see [Example Information Hierarchy](https://www.itwinjs.org/bis/guide/data-organization/information-hierarchy/#example-information-hierarchy). + +This transformation allows to optimize iModel for better viewing performance. You can notice lack of performance when model count reaches ~1000 or even more models. +You can select ~ 5-20 models by EC query and test the performance of the iModel. + +Explanation of specific properties configuration. +``` +modelGroups - property specifies an array of target model names with source model queries that you want to transform. This property is required. +groupUnselectedModels - optional parameter which indicates your decision on grouping unselected models. Default value is false. +unselectedModelsGroupName - optional parameter which sets name for unselected models group. You must specify the name if groupUnselectedModels is true. +simplifyGeometry - optional parameter indicating if geometry simplification should be used (transforming parasolids to meshes). Default if not specified - false. +``` +
+ +{!TransformerMetadata.md!} + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/combinephysicalmodelsv2/displayName.md b/services/transformations/v1/operations/combinephysicalmodelsv2/displayName.md new file mode 100644 index 0000000..ad7b2b5 --- /dev/null +++ b/services/transformations/v1/operations/combinephysicalmodelsv2/displayName.md @@ -0,0 +1 @@ +CombinePhysicalModelsV2 \ No newline at end of file diff --git a/services/transformations/v1/operations/create-transformation/description.md b/services/transformations/v1/operations/create-transformation/description.md new file mode 100644 index 0000000..41e56c5 --- /dev/null +++ b/services/transformations/v1/operations/create-transformation/description.md @@ -0,0 +1,19 @@ +--- + +This endpoint is used to run the transformation based on an already created configuration. Sending a post request will submit a background processing job that is able to report progress back to the same transformation instance that you can query by the transformation ID. + +First run of the transformation will process the whole source iModel and push data to the target iModel. +Only one transformation job can run on the same target iModel at the same time. +Consecutively submitted jobs for the same configurationId will only process changes to the source iModel. + +{!TransformationStatus.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +{!TransformationElementLimiting.md!} + +--- diff --git a/services/transformations/v1/operations/create-transformation/displayName.md b/services/transformations/v1/operations/create-transformation/displayName.md new file mode 100644 index 0000000..bf6ec3c --- /dev/null +++ b/services/transformations/v1/operations/create-transformation/displayName.md @@ -0,0 +1 @@ +Create Transformation \ No newline at end of file diff --git a/services/transformations/v1/operations/createfork/description.md b/services/transformations/v1/operations/createfork/description.md new file mode 100644 index 0000000..a49bffd --- /dev/null +++ b/services/transformations/v1/operations/createfork/description.md @@ -0,0 +1,27 @@ +--- + +This endpoint is used to create a configuration for a CreateFork transformation. + +CreateFork transformation is used for establishing a (*main <-> fork*) relationship between 2 iModels and for synchronizing changes in the "forward" (*main -> fork*) direction. + +The first time a CreateFork transformation is performed, a link is established between source (main) and the target (fork) iModels. The target iModel must be a clone of the source iModel. You can clone the existing iModel using iModels API's endpoints: +- [Create iModel](/apis/imodels-v2/operations/create-imodel/). +- [Clone iModel](/apis/imodels-v2/operations/clone-imodel/). + +Consecutive CreateFork transformations may be used to pull changes from the main iModel into the fork iModel. + +To synchronize changes in the "reverse" (fork -> main) direction see [MergeFork configuration](/apis/transformations/operations/mergefork/). + +{!TransformerMetadata.md!} + +**Limitations**: Since an iModel can contain multiple forks there is a possibility that any given fork and the main iModel end up with conflicting schemas, e.g., the same ECProperty in one schema is of type "number" and in another schema it is of type "string". Schema conflicts are not handled by the transformations service and in these cases the transformation will fail. + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/createfork/displayName.md b/services/transformations/v1/operations/createfork/displayName.md new file mode 100644 index 0000000..fc5c3e3 --- /dev/null +++ b/services/transformations/v1/operations/createfork/displayName.md @@ -0,0 +1 @@ +CreateFork \ No newline at end of file diff --git a/services/transformations/v1/operations/delete-configuration/description.md b/services/transformations/v1/operations/delete-configuration/description.md new file mode 100644 index 0000000..506828f --- /dev/null +++ b/services/transformations/v1/operations/delete-configuration/description.md @@ -0,0 +1,11 @@ +--- + +This endpoint is used to delete a configuration entity with a provided configurationId. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/delete-configuration/displayName.md b/services/transformations/v1/operations/delete-configuration/displayName.md new file mode 100644 index 0000000..fe6c47e --- /dev/null +++ b/services/transformations/v1/operations/delete-configuration/displayName.md @@ -0,0 +1 @@ +Delete Configuration \ No newline at end of file diff --git a/services/transformations/v1/operations/delete-transformation/description.md b/services/transformations/v1/operations/delete-transformation/description.md new file mode 100644 index 0000000..84b9ac5 --- /dev/null +++ b/services/transformations/v1/operations/delete-transformation/description.md @@ -0,0 +1,11 @@ +--- + +This endpoint is used to delete an ongoing transformation for a provided transformationId. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/delete-transformation/displayName.md b/services/transformations/v1/operations/delete-transformation/displayName.md new file mode 100644 index 0000000..907f1f4 --- /dev/null +++ b/services/transformations/v1/operations/delete-transformation/displayName.md @@ -0,0 +1 @@ +Delete Transformation \ No newline at end of file diff --git a/services/transformations/v1/operations/filterbyviewdefinition/description.md b/services/transformations/v1/operations/filterbyviewdefinition/description.md new file mode 100644 index 0000000..e23d97a --- /dev/null +++ b/services/transformations/v1/operations/filterbyviewdefinition/description.md @@ -0,0 +1,69 @@ +--- + +This endpoint is used to create a configuration for filtering iModel data based on a view definition or a saved view. + +A View renders geometry from one or more Models of an iModel in a web browser. A View is an element of the ViewDefinition class. For more information, see [Using Views in iTwin.js](https://www.itwinjs.org/learning/frontend/views/). + +This transformation is usually leveraged to filter out unnecessary data and align an iModel to the view within a browser window. + +**Limitations**: Saved views are capable of displaying elements while hiding their parent elements. +This cannot be achieved by filtering logic because child elements cannot exist without their parent elements within an iModel. +To workaround this misalignment between display and filtering logic, the transformations service does not filter out: + +- elements that are ancestors of visible child elements +- elements that are scoping ancestors of visible elements + +Such elements will remain in iModel with cleared properties, meaning that their geometries and other non mandatory properties will be deleted. + +Configuration specific properties explained: + +``` +models - ids of enabled/visible models contained within a view definition. +hiddenModels - ids of disabled/hidden models contained within a view definition. +categories - ids of visible enabled/categories contained within a view definition. +hiddenCategories - ids of disabled/hidden categories contained within a view definition. +neverDrawn - element ids which should be left out of the target iModel. +alwaysDrawn - element ids which should be included in to the target iModel. +isAlwaysDrawnExclusive - boolean flag that determines whether all elements, except those defined in "alwaysDrawn", should be filtered out. The default value is false if not specified. +subCategoryOvr + - subCategory - id of sub category + - invisible - geometry belonging to an invisible subCategory will be left out of target iModel +clip - data needed to create clipping. This cannot be an empty object. + - shapes - array of shape clippings + - points - array of number arrays describing the polygon. Each low level array contains numbers corresponding to coordinates [x, y, z] + - trans - array of number arrays describing the transform applied to the polygon. Each low level array contains four numbers of a transform row [qx, qy, qz, ax]. + - zlow - lower bound on Z. + - zhigh - upper bound on Z. + - mask - `true` if this shape is a mask. + - invisible -`true` if this shape is invisible. + - planes - array of plane line clippings + - invisible - `true` if this union of plane clip intersections is invisible. + - clips - a union of plane clip set intersections + - normal - the plane's inward normal as a number array corresponding to coordinates [x, y ,z]. + - dist - the plane's distance from the origin. + - invisible - `true` if this plane is invisible. + - interior - `true` if this plane is interior. +perModelCategoryVisibility - array of objects containing perModelCategoryVisibility data + - modelId - id of model for which category override will apply. + - categoryId - id of category for which the override will apply. + - visible - boolean flag indicating if category is visible for the given model. +viewMode - enumerator that specifies the transformation saved view mode. It can have two values: IncludeNewContent and FilterContent. + - IncludeNewContent includes all new content that was introduced into the iModel after the view was created. + - FilterContent filters out all new content that was introduced into the iModel after the view was created. +``` + +All ids must be well-formed valid hexadecimal ids conforming with [iTwin.js specification](https://www.itwinjs.org/learning/common/id64/?term=id64). + +PerModelCategoryVisibility override affects geometry on all subcategories belonging to the overridden category. That is, if the category is overridden to be visible, then geometry on all subcategories of the category will be visible, regardless of any subCategory overrides. + +{!TransformerMetadata.md!} + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/filterbyviewdefinition/displayName.md b/services/transformations/v1/operations/filterbyviewdefinition/displayName.md new file mode 100644 index 0000000..88195ee --- /dev/null +++ b/services/transformations/v1/operations/filterbyviewdefinition/displayName.md @@ -0,0 +1 @@ +FilterByViewDefinition \ No newline at end of file diff --git a/services/transformations/v1/operations/filterimodel/description.md b/services/transformations/v1/operations/filterimodel/description.md new file mode 100644 index 0000000..80604e5 --- /dev/null +++ b/services/transformations/v1/operations/filterimodel/description.md @@ -0,0 +1,25 @@ +--- + +This endpoint is used to create a configuration for filtering iModel data based on an ECSql query. + +ECSQL is a text-based command language for CRUD (create, read, update, delete) operations against the business data in an iModel or ECDb file. For more information, samples and tutorials see [ECSQL](https://www.itwinjs.org/learning/ecsql/). + +Configuration specific properties explained: + +``` +ecSql - ECSql query that only selects ECInstanceIds of elements that the iModel will be filtered by. +inclusive - 'false' when all elements selected by ecSql query are filtered out, 'true' when all physical elements that are not selected by ecSql query are filtered out. By default it is 'false'. +``` +
+ +{!TransformerMetadata.md!} + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/filterimodel/displayName.md b/services/transformations/v1/operations/filterimodel/displayName.md new file mode 100644 index 0000000..b65420e --- /dev/null +++ b/services/transformations/v1/operations/filterimodel/displayName.md @@ -0,0 +1 @@ +FilterIModel \ No newline at end of file diff --git a/services/transformations/v1/operations/filtersubcategories/description.md b/services/transformations/v1/operations/filtersubcategories/description.md new file mode 100644 index 0000000..3fb0e7e --- /dev/null +++ b/services/transformations/v1/operations/filtersubcategories/description.md @@ -0,0 +1,26 @@ +--- + +This endpoint is used to create a configuration for filtering out geometry entries based on their sub-category names. + +A SubCategory is a subdivision of a Category. SubCategories allow elements in iModel to have multiple pieces of geometry that can be independently visible and styled (color, linesStyle, transparency, etc.). For more information, see [SubCategories](https://www.itwinjs.org/bis/intro/categories/#subcategories). + +FilterSubCategories transformation is filtering out all of the data associated to subCategoryNames specified for the transformation. + +Configuration specific properties explained: + +``` +subCategoryNames - array of sub category names. +``` +
+ +{!TransformerMetadata.md!} + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/filtersubcategories/displayName.md b/services/transformations/v1/operations/filtersubcategories/displayName.md new file mode 100644 index 0000000..f4c1656 --- /dev/null +++ b/services/transformations/v1/operations/filtersubcategories/displayName.md @@ -0,0 +1 @@ +FilterSubCategories \ No newline at end of file diff --git a/services/transformations/v1/operations/get-all-configurations/description.md b/services/transformations/v1/operations/get-all-configurations/description.md new file mode 100644 index 0000000..5da7544 --- /dev/null +++ b/services/transformations/v1/operations/get-all-configurations/description.md @@ -0,0 +1,13 @@ +--- + +This endpoint is used to query a list of configuration entities. + +To get full configuration entities in a list set prefer header to `return=representation`. + +**Note:** when `return=representation` is used, the type on entities returned in `configurations` array is a union of different configuration types. Configuration type is denoted by `transformType` property. API consumers should expect that new configuration types will added in the future. New configurations may have a different schema than the ones that currently exist so array items should be deserialized based on `transformType`. + +{!Authorization.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/transformations/v1/operations/get-all-configurations/displayName.md b/services/transformations/v1/operations/get-all-configurations/displayName.md new file mode 100644 index 0000000..d0f8b98 --- /dev/null +++ b/services/transformations/v1/operations/get-all-configurations/displayName.md @@ -0,0 +1 @@ +Get All Configurations \ No newline at end of file diff --git a/services/transformations/v1/operations/get-all-transformations/description.md b/services/transformations/v1/operations/get-all-transformations/description.md new file mode 100644 index 0000000..29c9d00 --- /dev/null +++ b/services/transformations/v1/operations/get-all-transformations/description.md @@ -0,0 +1,13 @@ +--- + +This endpoint is used to query a list of transformation entities. + +To get full transformation entities in a list set prefer header to `return=representation`. + +{!TransformationStatus.md!} + +{!Authorization.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/transformations/v1/operations/get-all-transformations/displayName.md b/services/transformations/v1/operations/get-all-transformations/displayName.md new file mode 100644 index 0000000..882d11f --- /dev/null +++ b/services/transformations/v1/operations/get-all-transformations/displayName.md @@ -0,0 +1 @@ +Get All Transformations \ No newline at end of file diff --git a/services/transformations/v1/operations/get-configuration/description.md b/services/transformations/v1/operations/get-configuration/description.md new file mode 100644 index 0000000..709fb25 --- /dev/null +++ b/services/transformations/v1/operations/get-configuration/description.md @@ -0,0 +1,13 @@ +--- + +This endpoint is used to query a configuration entity with a provided configurationId. + +**Note:** the type of `configuration` in operation response is a union of different configuration types. Configuration type is denoted by `transformType` property. API consumers should expect that new configuration types will added in the future. New configurations may have a different schema than the ones that currently exist so `configuration` should be deserialized based on `transformType`. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/transformations/v1/operations/get-configuration/displayName.md b/services/transformations/v1/operations/get-configuration/displayName.md new file mode 100644 index 0000000..804a67e --- /dev/null +++ b/services/transformations/v1/operations/get-configuration/displayName.md @@ -0,0 +1 @@ +Get Configuration \ No newline at end of file diff --git a/services/transformations/v1/operations/get-transformation/description.md b/services/transformations/v1/operations/get-transformation/description.md new file mode 100644 index 0000000..8f16704 --- /dev/null +++ b/services/transformations/v1/operations/get-transformation/description.md @@ -0,0 +1,13 @@ +--- + +This endpoint is used to track progress of a transformation for a provided transformationId. + +{!TransformationStatus.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- \ No newline at end of file diff --git a/services/transformations/v1/operations/get-transformation/displayName.md b/services/transformations/v1/operations/get-transformation/displayName.md new file mode 100644 index 0000000..2ef52d5 --- /dev/null +++ b/services/transformations/v1/operations/get-transformation/displayName.md @@ -0,0 +1 @@ +Get Transformation \ No newline at end of file diff --git a/services/transformations/v1/operations/groupandmap/description.md b/services/transformations/v1/operations/groupandmap/description.md new file mode 100644 index 0000000..3f7b225 --- /dev/null +++ b/services/transformations/v1/operations/groupandmap/description.md @@ -0,0 +1,40 @@ +--- + +This endpoint is used to create the Group And Map configuration. + +The Group And Map transformation enables the creation of new custom EC schemas and is capable of remapping already existing elements to the new EC classes with new EC properties. The custom schema is constructed using grouping and mapping data. It is your responsibility to create a valid mapping for the source iModel through [the Reporting API](/apis/insights/) before starting the transformation. To learn more about EC schemas and classes, please see [Base Infrastructure Schemas](https://www.itwinjs.org/bis/). + +These are the logical relations from [grouping and mapping](/apis/insights/operations/create-mapping/) data to EC schema: +``` +Mapping -> EC schema +Group -> EC class +GroupProperty -> EC property +``` + +After the transformation all elements that were *selected* with the group query will be remapped to the corresponding EC class. These elements will also have all the new EC properties inserted. The newly inserted EC properties' values will be populated with the help of 'ecProperties' field taken from the respective GroupProperty which you configured beforehand. + +POST configuration specific properties explained: +``` +mappingId - source iModel mapping id. +groupOverrides - list of overrides for each group. + - groupId - id of mapping group. + - baseClass - base EC class that will be applied for elements selected by group. + - ecSchemaName - EC schema name. + - ecClassName - EC class name. +additionalEcSchemas - list of additional EC schemas that will be added to target iModel. + - ecSchemaName - EC schema name. + - ecSchemaVersion - EC schema version. +``` +
+ +{!TransformerMetadata.md!} + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/groupandmap/displayName.md b/services/transformations/v1/operations/groupandmap/displayName.md new file mode 100644 index 0000000..577ea72 --- /dev/null +++ b/services/transformations/v1/operations/groupandmap/displayName.md @@ -0,0 +1 @@ +GroupAndMap \ No newline at end of file diff --git a/services/transformations/v1/operations/importimodel/description.md b/services/transformations/v1/operations/importimodel/description.md new file mode 100644 index 0000000..83b8bad --- /dev/null +++ b/services/transformations/v1/operations/importimodel/description.md @@ -0,0 +1,21 @@ +--- + +This endpoint is used to create a configuration for an ImportIModel transformation. + +Import iModel transformation imports an iModel from source project to specified target. + +Multiple iModels may be imported into the same target iModel, effectively combining them. + +Element conflicts can occur when importing an iModel. In this case, elements of the iModel being imported overwrite the target elements. Only elements whose scoping hierarchy ultimately reaches elements with ids `0x10` (dictionaryId) and `0xe` will be able to conflict with each other (most common cases are `DefinitionElement`s). + +{!TransformerMetadata.md!} + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/importimodel/displayName.md b/services/transformations/v1/operations/importimodel/displayName.md new file mode 100644 index 0000000..a8b752d --- /dev/null +++ b/services/transformations/v1/operations/importimodel/displayName.md @@ -0,0 +1 @@ +ImportIModel \ No newline at end of file diff --git a/services/transformations/v1/operations/mergefork/description.md b/services/transformations/v1/operations/mergefork/description.md new file mode 100644 index 0000000..12fa56a --- /dev/null +++ b/services/transformations/v1/operations/mergefork/description.md @@ -0,0 +1,45 @@ +--- + +This endpoint is used to create a configuration for MergeFork transformation. + +MergeFork transformation should be used for synchronizing changes in the "reverse" (*fork -> main*) direction with Forks created using one of +[CreateFork](/apis/transformations/operations/createfork), [FilterIModel](/apis/transformations/operations/filterimodel), [FilterSubCategories](/apis/transformations/operations/filtersubcategories), [FilterByViewDefinition](/apis/transformations/operations/filterbyviewdefinition) transformations. Forks created using ["Fork iModel" operation in iModels API](/apis/imodels-v2/operations/fork-imodel/) should be synchronized using [MergeIModel](/apis/transformations/operations/mergeimodel) transformation. + +Forked iModel must have at least one new changeset with modifications for merging to succeed. + +Source and target (project & iModel) properties mark the data flow direction. That said MergeFork configuration's sourceProjectId/IModelId and targetProjectId/IModelId properties must be switched places as compared to the configuration that was used to fork the iModel. + +```json +{ + "sourceProjectId": "00000000-0000-0000-0000-000000000000", // forked iModel's project id + "sourceIModelId": "00000000-0000-0000-0000-000000000000", // forked iModel's id + "targetProjectId": "00000000-0000-0000-0000-000000000000", // main iModel's project id + "targetIModelId": "00000000-0000-0000-0000-000000000000", // main iModel's id + "transformParameters": { + "configurationId": "00000000-0000-0000-0000-000000000000" // id of a configuration that was used to create the fork + } +``` + +Explanation of specific properties configuration. +``` +configurationId - required property that specifies configuration id, which was used to fork the main iModel. +``` +
+ +Running consecutive transformations for this configuration will keep synchronizing newly added changes from fork iModel back into the main iModel. + +{!TransformerMetadata.md!} + +Differently from other transformation types, MergeFork transformation synchronizes changes in a "reverse" direction. This means that the metadata will be pushed to the source (fork) iModel instead of the target iModel. + +**Limitations**: Since an iModel can contain multiple forks there is a possibility that any given fork and the main iModel end up with conflicting schemas, e.g., the same ECProperty in one schema is of type "number" and in another schema it is of type "string". Schema conflicts are not handled by the transformations service and in these cases the transformation will fail. + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/mergefork/displayName.md b/services/transformations/v1/operations/mergefork/displayName.md new file mode 100644 index 0000000..4e7b890 --- /dev/null +++ b/services/transformations/v1/operations/mergefork/displayName.md @@ -0,0 +1 @@ +MergeFork \ No newline at end of file diff --git a/services/transformations/v1/operations/mergeimodel/description.md b/services/transformations/v1/operations/mergeimodel/description.md new file mode 100644 index 0000000..d6971a8 --- /dev/null +++ b/services/transformations/v1/operations/mergeimodel/description.md @@ -0,0 +1,40 @@ +--- + +This endpoint is used to create a configuration for Merge iModel transformation. + +Merge iModel transformation is used for synchronizing changes between fork and main iModels in either direction. + +Merge iModel transformation should be used to synchronize changes between main and fork iModels created using ["Fork iModel" operation in iModels API](/apis/imodels-v2/operations/fork-imodel/) whereas [Merge Fork](/apis/transformations/operations/mergefork) should be used with forks created using one of +[Create Fork](/apis/transformations/operations/createfork), [Filter IModel](/apis/transformations/operations/filterimodel), [Filter SubCategories](/apis/transformations/operations/filtersubcategories), [Filter By View Definition](/apis/transformations/operations/filterbyviewdefinition) transformations. + +{!RunningTransformation.md!} + +### Merge iModel transformation requirements + +iModel fork must be created using [Fork iModel operation](/apis/imodels-v2/operations/fork-imodel/) in iModels API. Additionally, all elements in both fork and main iModels must have `FederationGuid` property set to a non `null` value. If that is not the case, [PopulateFederationGuids transformation](/apis/transformations/operations/populatefederationguids/) can be used to set missing `FederationGuid` values. + +### Merge direction + +Source and target (project & iModel) properties mark the data flow direction: + +- If `sourceIModelId` is iModel **fork** and `targetIModelId` is **main** iModel, it means that iModel fork is being merged to main iModel. +- If `sourceIModelId` is **main** iModel and `targetIModelId` is iModel **fork**, it means that main iModel is being merged to iModel fork. + +Running consecutive transformations for this configuration will keep synchronizing newly added changes in the specified direction. + +### Transformation state persistence in iModel fork + +In addition to exported data, the transformer will also push some additional metadata to iModel fork. This metadata contains: + +1. `BisCore:RepositoryLink` and `BisCore:ExternalSource` elements that mark the source where the data was imported from. +1. A "Scope" `BisCore:ExternalSourceAspect` that contains Synchronization changeset metadata that is needed by the transformation service to process any later changes correctly. + +{!Authorization.md!} + +{!iModelsPermissions.md!} + +**Important**: Merge iModel transformation is in closed preview mode currently and only selected applications can utilize it. + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/mergeimodel/displayName.md b/services/transformations/v1/operations/mergeimodel/displayName.md new file mode 100644 index 0000000..26f92b3 --- /dev/null +++ b/services/transformations/v1/operations/mergeimodel/displayName.md @@ -0,0 +1 @@ +MergeIModel \ No newline at end of file diff --git a/services/transformations/v1/operations/populatefederationguids/description.md b/services/transformations/v1/operations/populatefederationguids/description.md new file mode 100644 index 0000000..15fdebe --- /dev/null +++ b/services/transformations/v1/operations/populatefederationguids/description.md @@ -0,0 +1,19 @@ +--- + +This endpoint is used to create a configuration for a PopulateFederationGuids transformation. + +Populate Federation Guids transformation creates a new [`FederationGuid`](https://www.itwinjs.org/bis/guide/fundamentals/federationguids/) property value on elements that currently have `FederationGuid` value set to `null`. + +This transformation is useful in [iModel Forking](https://developer.bentley.com/apis/imodels-v2/operations/fork-imodel/) scenarios when iModel fork creation in iModels API [fails with `sourceIsMissingFederationGuids` state](https://developer.bentley.com/apis/imodels-v2/operations/fork-imodel/#sourceismissingfederationguidsstate). After Populate Federation Guids transformation is run on the source iModel subsequent "Fork iModel" operations will succeed. + +{!RunningTransformation.md!} + +{!Authorization.md!} + +{!SingleIModelPermissions.md!} + +**Important**: Populate Federation Guids transformation is in closed preview mode currently and only selected applications can utilize it. + +{!RateLimits.md!} + +--- diff --git a/services/transformations/v1/operations/populatefederationguids/displayName.md b/services/transformations/v1/operations/populatefederationguids/displayName.md new file mode 100644 index 0000000..81e3a9a --- /dev/null +++ b/services/transformations/v1/operations/populatefederationguids/displayName.md @@ -0,0 +1 @@ +PopulateFederationGuids \ No newline at end of file diff --git a/services/users/v1/description.md b/services/users/v1/description.md new file mode 100644 index 0000000..18a4f4f --- /dev/null +++ b/services/users/v1/description.md @@ -0,0 +1 @@ +Access information about users. diff --git a/services/users/v1/operations/get-user/description.md b/services/users/v1/operations/get-user/description.md new file mode 100644 index 0000000..df7529a --- /dev/null +++ b/services/users/v1/operations/get-user/description.md @@ -0,0 +1,5 @@ +Gets the metadata for the specified user id. This API will only return metadata for users that are in the same organization as the caller. + +{!Authorization.md!} + +{!RateLimits.md!} diff --git a/services/users/v1/operations/get-user/displayName.md b/services/users/v1/operations/get-user/displayName.md new file mode 100644 index 0000000..5b0ab7b --- /dev/null +++ b/services/users/v1/operations/get-user/displayName.md @@ -0,0 +1 @@ +Get user \ No newline at end of file diff --git a/services/users/v1/operations/get-users-by-id-list/description.md b/services/users/v1/operations/get-users-by-id-list/description.md new file mode 100644 index 0000000..835854f --- /dev/null +++ b/services/users/v1/operations/get-users-by-id-list/description.md @@ -0,0 +1,7 @@ +This API allows you to pass a list of user ids and get back the user metadata for each one. It is implemented as a POST so that the ids can be specified in the body instead of the url. This allows you to specify up to 1000 user ids. + +This API will only return metadata for users that are in the same organization as the caller. + +{!Authorization.md!} + +{!RateLimits.md!} diff --git a/services/users/v1/operations/get-users-by-id-list/displayName.md b/services/users/v1/operations/get-users-by-id-list/displayName.md new file mode 100644 index 0000000..c268a23 --- /dev/null +++ b/services/users/v1/operations/get-users-by-id-list/displayName.md @@ -0,0 +1 @@ +Get users by id list \ No newline at end of file diff --git a/services/users/v1/operations/get-users/description.md b/services/users/v1/operations/get-users/description.md new file mode 100644 index 0000000..a19d16d --- /dev/null +++ b/services/users/v1/operations/get-users/description.md @@ -0,0 +1,7 @@ +Search for users by name or email. The search string is required and must be between 3 and 200 characters. Paging is not supported and it will not return more than 1000 users. + +This API will only return metadata for users that are in the same organization as the caller. + +{!Authorization.md!} + +{!RateLimits.md!} diff --git a/services/users/v1/operations/get-users/displayName.md b/services/users/v1/operations/get-users/displayName.md new file mode 100644 index 0000000..cedebc4 --- /dev/null +++ b/services/users/v1/operations/get-users/displayName.md @@ -0,0 +1 @@ +Get users \ No newline at end of file diff --git a/services/users/v1/operations/me/description.md b/services/users/v1/operations/me/description.md new file mode 100644 index 0000000..f9ebb57 --- /dev/null +++ b/services/users/v1/operations/me/description.md @@ -0,0 +1,5 @@ +Retrieve the logged in user's profile. + +{!Authorization.md!} + +{!RateLimits.md!} diff --git a/services/users/v1/operations/me/displayName.md b/services/users/v1/operations/me/displayName.md new file mode 100644 index 0000000..4139a6a --- /dev/null +++ b/services/users/v1/operations/me/displayName.md @@ -0,0 +1 @@ +me \ No newline at end of file diff --git a/services/validation/v1/description.md b/services/validation/v1/description.md new file mode 100644 index 0000000..0e7bdb4 --- /dev/null +++ b/services/validation/v1/description.md @@ -0,0 +1 @@ +The Property Validation API allows you to manage property value validation rules, tests, runs, and results. You can run tests and monitor the progress. \ No newline at end of file diff --git a/services/validation/v1/operations/create-validation-propertyvalue-rule/description.md b/services/validation/v1/operations/create-validation-propertyvalue-rule/description.md new file mode 100644 index 0000000..54b2fa5 --- /dev/null +++ b/services/validation/v1/operations/create-validation-propertyvalue-rule/description.md @@ -0,0 +1,9 @@ +--- + +Creates a property value validation rule for the specified criteria and returns the rule id. + +- Discover rule template ids by calling [GET /validation/propertyValue/ruleTemplates](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rule-templates/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/validation/v1/operations/create-validation-propertyvalue-rule/displayName.md b/services/validation/v1/operations/create-validation-propertyvalue-rule/displayName.md new file mode 100644 index 0000000..6b16fc4 --- /dev/null +++ b/services/validation/v1/operations/create-validation-propertyvalue-rule/displayName.md @@ -0,0 +1 @@ +Create property value validation rule \ No newline at end of file diff --git a/services/validation/v1/operations/create-validation-propertyvalue-tests/description.md b/services/validation/v1/operations/create-validation-propertyvalue-tests/description.md new file mode 100644 index 0000000..c103d64 --- /dev/null +++ b/services/validation/v1/operations/create-validation-propertyvalue-tests/description.md @@ -0,0 +1,9 @@ +--- + +Creates property value validation test for the specified criteria and returns the test id. + +- Discover rule ids by calling [GET /validation/propertyValue/rules](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rules/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/validation/v1/operations/create-validation-propertyvalue-tests/displayName.md b/services/validation/v1/operations/create-validation-propertyvalue-tests/displayName.md new file mode 100644 index 0000000..79576eb --- /dev/null +++ b/services/validation/v1/operations/create-validation-propertyvalue-tests/displayName.md @@ -0,0 +1 @@ +Create property value validation test \ No newline at end of file diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-rule/description.md b/services/validation/v1/operations/delete-validation-propertyvalue-rule/description.md new file mode 100644 index 0000000..c864016 --- /dev/null +++ b/services/validation/v1/operations/delete-validation-propertyvalue-rule/description.md @@ -0,0 +1,9 @@ +--- + +Deletes the property value validation rule for the specified rule id. + +- Discover rule ids by calling [GET /validation/propertyValue/rules](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rules/) + +{!Authorization.md!} + +--- diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-rule/displayName.md b/services/validation/v1/operations/delete-validation-propertyvalue-rule/displayName.md new file mode 100644 index 0000000..b9dcffb --- /dev/null +++ b/services/validation/v1/operations/delete-validation-propertyvalue-rule/displayName.md @@ -0,0 +1 @@ +Delete property value validation rule \ No newline at end of file diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-run/description.md b/services/validation/v1/operations/delete-validation-propertyvalue-run/description.md new file mode 100644 index 0000000..617f5ee --- /dev/null +++ b/services/validation/v1/operations/delete-validation-propertyvalue-run/description.md @@ -0,0 +1,9 @@ +--- + +Deletes a property value validation run for specified run id. + +- Discover run ids by calling [GET /validation/propertyValue/runs](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-runs/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-run/displayName.md b/services/validation/v1/operations/delete-validation-propertyvalue-run/displayName.md new file mode 100644 index 0000000..72c24e4 --- /dev/null +++ b/services/validation/v1/operations/delete-validation-propertyvalue-run/displayName.md @@ -0,0 +1 @@ +Delete property value validation run \ No newline at end of file diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-test/description.md b/services/validation/v1/operations/delete-validation-propertyvalue-test/description.md new file mode 100644 index 0000000..2325ddf --- /dev/null +++ b/services/validation/v1/operations/delete-validation-propertyvalue-test/description.md @@ -0,0 +1,9 @@ +--- + +Deletes the property value validation test for the specified test id. + +- Discover test ids by calling [GET /validation/propertyValue/tests](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-tests/) + +{!Authorization.md!} + +--- diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-test/displayName.md b/services/validation/v1/operations/delete-validation-propertyvalue-test/displayName.md new file mode 100644 index 0000000..71c40be --- /dev/null +++ b/services/validation/v1/operations/delete-validation-propertyvalue-test/displayName.md @@ -0,0 +1 @@ +Delete property value validation test \ No newline at end of file diff --git a/services/validation/v1/operations/get-validation-propertyvalue-properties/description.md b/services/validation/v1/operations/get-validation-propertyvalue-properties/description.md new file mode 100644 index 0000000..9909849 --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-properties/description.md @@ -0,0 +1,11 @@ +--- + +Gets the properties matching a filter string for the latest named version of an iModel. This request relies on a previous call to start schema extraction on an agent. Since this extraction completes asynchronously, the user can send this request periodically until a status of 'available' is returned in the response. + +- Discover iModel ids by calling [GET /imodels](/api-groups/data-management/apis/imodels/operations/get-project-imodels/) + +- Extract iModel schemas by calling [POST /clashdetection/schemas/imodels](/api-groups/validation/apis/clash-detection/operations/extract-schema-info/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/validation/v1/operations/get-validation-propertyvalue-properties/displayName.md b/services/validation/v1/operations/get-validation-propertyvalue-properties/displayName.md new file mode 100644 index 0000000..d06594f --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-properties/displayName.md @@ -0,0 +1 @@ +Get property value validation properties \ No newline at end of file diff --git a/services/validation/v1/operations/get-validation-propertyvalue-result/description.md b/services/validation/v1/operations/get-validation-propertyvalue-result/description.md new file mode 100644 index 0000000..a0fb41e --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-result/description.md @@ -0,0 +1,9 @@ +--- + +Gets the property value validation result details for the specified result id. + +- Discover result ids by calling [GET /validation/propertyValue/runs](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-runs/) + +{!Authorization.md!} + +--- diff --git a/services/validation/v1/operations/get-validation-propertyvalue-result/displayName.md b/services/validation/v1/operations/get-validation-propertyvalue-result/displayName.md new file mode 100644 index 0000000..cefe97b --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-result/displayName.md @@ -0,0 +1 @@ +Get property value validation result details \ No newline at end of file diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rule-templates/description.md b/services/validation/v1/operations/get-validation-propertyvalue-rule-templates/description.md new file mode 100644 index 0000000..98c5334 --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-rule-templates/description.md @@ -0,0 +1,7 @@ +--- + +Retrieves a list of property value validation rule templates for the project specified by the project id. + +{!Authorization.md!} + +--- diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rule-templates/displayName.md b/services/validation/v1/operations/get-validation-propertyvalue-rule-templates/displayName.md new file mode 100644 index 0000000..41231da --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-rule-templates/displayName.md @@ -0,0 +1 @@ +Get property value validation rule templates \ No newline at end of file diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rule/description.md b/services/validation/v1/operations/get-validation-propertyvalue-rule/description.md new file mode 100644 index 0000000..981cab0 --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-rule/description.md @@ -0,0 +1,9 @@ +--- + +Gets the property value validation rule details for the specified rule id. + +- Discover rule ids by calling [GET /validation/propertyValue/rules](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rules/) + +{!Authorization.md!} + +--- diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rule/displayName.md b/services/validation/v1/operations/get-validation-propertyvalue-rule/displayName.md new file mode 100644 index 0000000..3064256 --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-rule/displayName.md @@ -0,0 +1 @@ +Get property value validation rule \ No newline at end of file diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rules/description.md b/services/validation/v1/operations/get-validation-propertyvalue-rules/description.md new file mode 100644 index 0000000..f0f9451 --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-rules/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves a list of property value validation rules for the project specified by the project id. + +### Notes + +The Prefer header can be used to specify how much rule metadata is desired + +- "return=minimal" (default) - returns the minimum property value validation rule metadata + +- "return=representation" - returns the full property value validation rule metadata + +{!Authorization.md!} + +--- diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rules/displayName.md b/services/validation/v1/operations/get-validation-propertyvalue-rules/displayName.md new file mode 100644 index 0000000..26d1c4a --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-rules/displayName.md @@ -0,0 +1 @@ +Get property value validation rules \ No newline at end of file diff --git a/services/validation/v1/operations/get-validation-propertyvalue-run/description.md b/services/validation/v1/operations/get-validation-propertyvalue-run/description.md new file mode 100644 index 0000000..9a3fec4 --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-run/description.md @@ -0,0 +1,11 @@ +--- + +Retrieves details of a validation run for the run specified by the run id. + +- Links are included to retrieve the associated test and result. The run status in the response can be polled periodically as the agent job completes asynchronously. Calling the link to get the result before the run status is 'completed' will return a 202 response. + +- Discover run ids by calling [GET /validation/propertyValue/runs](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-runs/) + +{!Authorization.md!} + +--- diff --git a/services/validation/v1/operations/get-validation-propertyvalue-run/displayName.md b/services/validation/v1/operations/get-validation-propertyvalue-run/displayName.md new file mode 100644 index 0000000..5eee55a --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-run/displayName.md @@ -0,0 +1 @@ +Get property value validation run \ No newline at end of file diff --git a/services/validation/v1/operations/get-validation-propertyvalue-runs/description.md b/services/validation/v1/operations/get-validation-propertyvalue-runs/description.md new file mode 100644 index 0000000..cefbe11 --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-runs/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves a list of property value validation runs for the project specified by the project id. + +### Notes + +The Prefer header can be used to specify how much validation run metadata is desired + +- "return=minimal" (default) - returns the minimum property value validation run metadata + +- "return=representation" - returns the full property value validation run metadata + +{!Authorization.md!} + +--- diff --git a/services/validation/v1/operations/get-validation-propertyvalue-runs/displayName.md b/services/validation/v1/operations/get-validation-propertyvalue-runs/displayName.md new file mode 100644 index 0000000..82c3e0a --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-runs/displayName.md @@ -0,0 +1 @@ +Get property value validation runs \ No newline at end of file diff --git a/services/validation/v1/operations/get-validation-propertyvalue-test/description.md b/services/validation/v1/operations/get-validation-propertyvalue-test/description.md new file mode 100644 index 0000000..50a2e77 --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-test/description.md @@ -0,0 +1,9 @@ +--- + +Gets the property value validation test details for the specified test id. + +- Discover test ids by calling [GET /validation/propertyValue/tests](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-tests/) + +{!Authorization.md!} + +--- diff --git a/services/validation/v1/operations/get-validation-propertyvalue-test/displayName.md b/services/validation/v1/operations/get-validation-propertyvalue-test/displayName.md new file mode 100644 index 0000000..94a22c4 --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-test/displayName.md @@ -0,0 +1 @@ +Get property value validation test details \ No newline at end of file diff --git a/services/validation/v1/operations/get-validation-propertyvalue-tests/description.md b/services/validation/v1/operations/get-validation-propertyvalue-tests/description.md new file mode 100644 index 0000000..ffcdd2f --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-tests/description.md @@ -0,0 +1,9 @@ +--- + +Retrieves a list of property value validation tests for the project specified by the project id. + +### Notes + +{!Authorization.md!} + +--- diff --git a/services/validation/v1/operations/get-validation-propertyvalue-tests/displayName.md b/services/validation/v1/operations/get-validation-propertyvalue-tests/displayName.md new file mode 100644 index 0000000..95d510b --- /dev/null +++ b/services/validation/v1/operations/get-validation-propertyvalue-tests/displayName.md @@ -0,0 +1 @@ +Get property value validation tests \ No newline at end of file diff --git a/services/validation/v1/operations/run-validation-propertyvalue-test/description.md b/services/validation/v1/operations/run-validation-propertyvalue-test/description.md new file mode 100644 index 0000000..9aafd5f --- /dev/null +++ b/services/validation/v1/operations/run-validation-propertyvalue-test/description.md @@ -0,0 +1,17 @@ +--- + +Runs a property value validation test for the specified test id and returns the run id. The maximum number of validation failures may be specified with the resultsLimit parameter in the request body. If none is specified, the default is 100,000. + +- This API has a rate limit of 6 API calls per second. If an application exceeds the rate limit it will receive an HTTP error code 429 "Too Many Requests". The error response includes a Retry-After header that indicates how long clients should wait before retrying. + +- A link is included to retrieve the run status as the agent job completes asynchronously. + +- Discover test ids by calling [GET /validation/propertyValue/tests](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-tests/) + +- Discover iModel ids by calling [GET /imodels](/api-groups/data-management/apis/imodels/operations/get-project-imodels/) + +- Discover named version ids by calling [GET /imodels/{id}/namedversions](/api-groups/data-management/apis/imodels/operations/get-imodel-named-versions/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/validation/v1/operations/run-validation-propertyvalue-test/displayName.md b/services/validation/v1/operations/run-validation-propertyvalue-test/displayName.md new file mode 100644 index 0000000..812a7db --- /dev/null +++ b/services/validation/v1/operations/run-validation-propertyvalue-test/displayName.md @@ -0,0 +1 @@ +Run property value validation test \ No newline at end of file diff --git a/services/validation/v1/operations/update-validation-propertyvalue-rule/description.md b/services/validation/v1/operations/update-validation-propertyvalue-rule/description.md new file mode 100644 index 0000000..e0c71f1 --- /dev/null +++ b/services/validation/v1/operations/update-validation-propertyvalue-rule/description.md @@ -0,0 +1,9 @@ +--- + +Updates a property value validation rule for the specified criteria and returns the id of the successfully updated rule. + +- Discover rule ids by calling [GET /validation/propertyValue/rules](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rules/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/validation/v1/operations/update-validation-propertyvalue-rule/displayName.md b/services/validation/v1/operations/update-validation-propertyvalue-rule/displayName.md new file mode 100644 index 0000000..6e639b2 --- /dev/null +++ b/services/validation/v1/operations/update-validation-propertyvalue-rule/displayName.md @@ -0,0 +1 @@ +Update property value validation rule \ No newline at end of file diff --git a/services/validation/v1/operations/update-validation-propertyvalue-test/description.md b/services/validation/v1/operations/update-validation-propertyvalue-test/description.md new file mode 100644 index 0000000..a76e5ac --- /dev/null +++ b/services/validation/v1/operations/update-validation-propertyvalue-test/description.md @@ -0,0 +1,11 @@ +--- + +Updates a property value validation test for the specified criteria and returns the id of the successfully updated test. + +- Discover test ids by calling [GET /validation/propertyValue/tests](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-tests/) + +- Discover rule ids by calling [GET /validation/propertyValue/rules](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rules/) + +{!Authorization.md!} + +--- \ No newline at end of file diff --git a/services/validation/v1/operations/update-validation-propertyvalue-test/displayName.md b/services/validation/v1/operations/update-validation-propertyvalue-test/displayName.md new file mode 100644 index 0000000..c07da9f --- /dev/null +++ b/services/validation/v1/operations/update-validation-propertyvalue-test/displayName.md @@ -0,0 +1 @@ +Update property value validation test \ No newline at end of file diff --git a/services/webhooks/v2/description.md b/services/webhooks/v2/description.md new file mode 100644 index 0000000..d4ff180 --- /dev/null +++ b/services/webhooks/v2/description.md @@ -0,0 +1,5 @@ +The Webhooks API allows you to subscribe to events happening in iTwin Platform. + +### Supported event sources + +- iModels events diff --git a/services/webhooks/v2/operations/create-webhook/description.md b/services/webhooks/v2/operations/create-webhook/description.md new file mode 100644 index 0000000..17616bd --- /dev/null +++ b/services/webhooks/v2/operations/create-webhook/description.md @@ -0,0 +1,33 @@ +Creates a new webhook. On creation, webhook are inactive by default. To start receiving event, make a request to the [update webhook endpoint](/apis/webhooks-v2/operations/update-webhook/) with the `active` property set to `true`. + +#### Callback Url (Required) + +The URL of the public endpoint all events will be sent to. `HTTPS` is required for this URL. This endpoint will receive requests containing events that have been triggered by different actions throughout the iTwin Platform. A POST request will be sent to this url when an event is triggered with event details in the body of the POST request. + +#### Scope (Required) + +The `scope` property is required. Currently, there are two accepted value for `scope`: `Account`, `iTwin`. + +All webhooks that are created with the `Account` scope are scoped to the account of the Service Application that created it. This means all events types the webhooks is subscribed to that happen inside that account will be sent to the webhook. Please be aware that Service Application's accounts are separate from the user's account that created the Service Application. + +If the webhoook is created with the `iTwin` scope, then the property `scopeId` is required. `iTwin` scoped Webhooks will receive events for anything that is created directly inside of that `iTwin`. + +#### Secret (Optional) + +The `secret` property is optional. If no secret is provided in the request a secret is generated and sent back in the response. If provided, the secret must be at least 32 characters. + +Before forwarding an event to the client, the webhook secret is used together with the whole request body to generate a `HMAC-SHA256` signature which is included in the `Signature` request header. Before doing anything with the received event the callback endpoint should handle the authorization process by using its own webhook secret copy together with request body and generate another signature on their end to validate the event source. If both signatures are the same, the event should be accepted as authorized. If the signatures do not match the event should be ignored. An example of this workflow can be found in our [tutorial](/tutorials/create-and-react-to-events-using-webhooks-v2/#23-add-event-authorization) or in our [samples](/apis/webhooks-v2/samples/). + +#### Event Types (Required) + +A list of events the webhooks will be subscribed to. See the [Events](/apis/webhooks-v2/available-events) page for a detailed list of all available event types. + +#### Authentication + +Webhooks can only be created by a Service Application. This request requires an `Authorization` header with a valid Bearer token with the `{scope}` scope. For more information on Service Applications and how to obtain an access token can be found [here](https://developer.bentley.com/tutorials/authorize-service/). A list of your Service Applications can be found [here](https://developer.bentley.com/my-apps). + +#### Authorization + +The Service Application must have the `webhooks_maintainer` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. diff --git a/services/webhooks/v2/operations/create-webhook/displayName.md b/services/webhooks/v2/operations/create-webhook/displayName.md new file mode 100644 index 0000000..57503f7 --- /dev/null +++ b/services/webhooks/v2/operations/create-webhook/displayName.md @@ -0,0 +1 @@ +Create webhook \ No newline at end of file diff --git a/services/webhooks/v2/operations/delete-webhook/description.md b/services/webhooks/v2/operations/delete-webhook/description.md new file mode 100644 index 0000000..7cad6c6 --- /dev/null +++ b/services/webhooks/v2/operations/delete-webhook/description.md @@ -0,0 +1,11 @@ +Delete the specified webhook. Once deleted, your webhook will stop receiving events. + +#### Authentication + +The Webhooks API V2 can only be called by Service Applications. This request requires an `Authorization` header with a valid Bearer token with the `{scope}` scope. For more information on Service Applications and how to obtain an access token can be found [here](https://developer.bentley.com/tutorials/authorize-service/). A list of your Service Applications can be found [here](https://developer.bentley.com/my-apps). + +#### Authorization + +The Service Application must have the `webhooks_maintainer` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. diff --git a/services/webhooks/v2/operations/delete-webhook/displayName.md b/services/webhooks/v2/operations/delete-webhook/displayName.md new file mode 100644 index 0000000..23c1f53 --- /dev/null +++ b/services/webhooks/v2/operations/delete-webhook/displayName.md @@ -0,0 +1 @@ +Delete webhook \ No newline at end of file diff --git a/services/webhooks/v2/operations/get-webhook/description.md b/services/webhooks/v2/operations/get-webhook/description.md new file mode 100644 index 0000000..fe5ca9d --- /dev/null +++ b/services/webhooks/v2/operations/get-webhook/description.md @@ -0,0 +1,11 @@ +Retrieves the specified webhook. + +#### Authentication + +The Webhooks API V2 can only be called by Service Applications. This request requires an `Authorization` header with a valid Bearer token with the `{scope}` scope. For more information on Service Applications and how to obtain an access token can be found [here](https://developer.bentley.com/tutorials/authorize-service/). A list of your Service Applications can be found [here](https://developer.bentley.com/my-apps). + +#### Authorization + +The Service Application must have the `webhooks_maintainer` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. diff --git a/services/webhooks/v2/operations/get-webhook/displayName.md b/services/webhooks/v2/operations/get-webhook/displayName.md new file mode 100644 index 0000000..ee54ede --- /dev/null +++ b/services/webhooks/v2/operations/get-webhook/displayName.md @@ -0,0 +1 @@ +Get webhook \ No newline at end of file diff --git a/services/webhooks/v2/operations/get-webhooks/description.md b/services/webhooks/v2/operations/get-webhooks/description.md new file mode 100644 index 0000000..4bf248c --- /dev/null +++ b/services/webhooks/v2/operations/get-webhooks/description.md @@ -0,0 +1,11 @@ +Retrieves a list of all webhooks that have been created by the calling user. + +#### Authentication + +The Webhooks API V2 can only be called by Service Applications. This request requires an `Authorization` header with a valid Bearer token with the `{scope}` scope. For more information on Service Applications and how to obtain an access token can be found [here](https://developer.bentley.com/tutorials/authorize-service/). A list of your Service Applications can be found [here](https://developer.bentley.com/my-apps). + +#### Authorization + +The Service Application must have the `webhooks_maintainer` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. diff --git a/services/webhooks/v2/operations/get-webhooks/displayName.md b/services/webhooks/v2/operations/get-webhooks/displayName.md new file mode 100644 index 0000000..49a0247 --- /dev/null +++ b/services/webhooks/v2/operations/get-webhooks/displayName.md @@ -0,0 +1 @@ +Get webhooks \ No newline at end of file diff --git a/services/webhooks/v2/operations/update-webhook/description.md b/services/webhooks/v2/operations/update-webhook/description.md new file mode 100644 index 0000000..3cf8d3d --- /dev/null +++ b/services/webhooks/v2/operations/update-webhook/description.md @@ -0,0 +1,39 @@ +Updates the specified webhook. + +#### Activation + +To activate a webhook, make a PATCH request with the `active` property set to `true`. By default, newly created webhooks are inactive by default and must be activated to start recieving events. + +The following is a sample PATCH request to activate a webhook. + +```http +PATCH https://api.bentley.com/webhooks/{webhookId} + +{ + "active": true +} +``` + +#### Deactivation + +To deactivate a webhook, make a PATCH request with the `active` property set to `false`. Once deactivated, your webhook will stop receiving events. + +The following is a sample PATCH request to deactivate a webhook. + +```http +PATCH https://api.bentley.com/webhooks/{webhookId} + +{ + "active": false +} +``` + +#### Authentication + +The Webhooks API V2 can only be called by Service Applications. This request requires an `Authorization` header with a valid Bearer token with the `{scope}` scope. For more information on Service Applications and how to obtain an access token can be found [here](https://developer.bentley.com/tutorials/authorize-service/). A list of your Service Applications can be found [here](https://developer.bentley.com/my-apps). + +#### Authorization + +The Service Application must have the `webhooks_maintainer` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. diff --git a/services/webhooks/v2/operations/update-webhook/displayName.md b/services/webhooks/v2/operations/update-webhook/displayName.md new file mode 100644 index 0000000..da25f95 --- /dev/null +++ b/services/webhooks/v2/operations/update-webhook/displayName.md @@ -0,0 +1 @@ +Update webhook \ No newline at end of file From e200044a3520fc7e7eed78e25af372324a89bc94 Mon Sep 17 00:00:00 2001 From: Linas B Date: Thu, 29 Aug 2024 13:21:41 +0300 Subject: [PATCH 2/5] Moved documentation to 'apis' folder --- apis/access-control/v2/description.md | 5 +++ .../add-itwin-group-members/description.md | 19 ++++++++++ .../add-itwin-group-members/displayName.md | 0 .../add-itwin-owner-member/description.md | 23 +++++++++++ .../add-itwin-owner-member/displayName.md | 0 .../add-itwin-user-members/description.md | 21 ++++++++++ .../add-itwin-user-members/displayName.md | 0 .../create-iTwin-role/description.md | 17 +++++++++ .../create-iTwin-role/displayName.md | 0 .../create-itwin-group/description.md | 19 ++++++++++ .../create-itwin-group/displayName.md | 0 .../create-itwin-job/description.md | 27 +++++++++++++ .../create-itwin-job/displayName.md | 0 .../delete-iTwin-role/description.md | 17 +++++++++ .../delete-iTwin-role/displayName.md | 0 .../delete-itwin-group/description.md | 19 ++++++++++ .../delete-itwin-group/displayName.md | 0 .../get-all-permissions/description.md | 15 ++++++++ .../get-all-permissions/displayName.md | 0 .../get-iTwin-permissions/description.md | 15 ++++++++ .../get-iTwin-permissions/displayName.md | 0 .../operations/get-iTwin-roles/description.md | 17 +++++++++ .../operations/get-iTwin-roles/displayName.md | 0 .../get-itwin-group-member/description.md | 17 +++++++++ .../get-itwin-group-member/displayName.md | 0 .../get-itwin-group-members/description.md | 17 +++++++++ .../get-itwin-group-members/displayName.md | 0 .../operations/get-itwin-group/description.md | 17 +++++++++ .../operations/get-itwin-group/displayName.md | 0 .../get-itwin-groups/description.md | 17 +++++++++ .../get-itwin-groups/displayName.md | 0 .../get-itwin-job-actions/description.md | 17 +++++++++ .../get-itwin-job-actions/displayName.md | 0 .../operations/get-itwin-job/description.md | 26 +++++++++++++ .../operations/get-itwin-job/displayName.md | 0 .../description.md | 13 +++++++ .../displayName.md | 0 .../get-itwin-owner-members/description.md | 38 +++++++++++++++++++ .../get-itwin-owner-members/displayName.md | 0 .../operations/get-itwin-role/description.md | 17 +++++++++ .../operations/get-itwin-role/displayName.md | 0 .../get-itwin-user-member/description.md | 38 +++++++++++++++++++ .../get-itwin-user-member/displayName.md | 0 .../get-itwin-user-members/description.md | 38 +++++++++++++++++++ .../get-itwin-user-members/displayName.md | 0 .../remove-itwin-group-member/description.md | 17 +++++++++ .../remove-itwin-group-member/displayName.md | 0 .../remove-itwin-owner-member/description.md | 19 ++++++++++ .../remove-itwin-owner-member/displayName.md | 0 .../remove-itwin-user-member/description.md | 17 +++++++++ .../remove-itwin-user-member/displayName.md | 0 .../update-iTwin-role/description.md | 17 +++++++++ .../update-iTwin-role/displayName.md | 0 .../update-itwin-group-member/description.md | 17 +++++++++ .../update-itwin-group-member/displayName.md | 0 .../update-itwin-group/description.md | 21 ++++++++++ .../update-itwin-group/displayName.md | 0 .../update-itwin-user-member/description.md | 17 +++++++++ .../update-itwin-user-member/displayName.md | 0 .../carbon-calculation/v1/description.md | 0 .../create-ec3-configuration/description.md | 0 .../create-ec3-configuration/displayName.md | 0 .../operations/create-ec3-job/description.md | 0 .../operations/create-ec3-job/displayName.md | 0 .../create-oneclicklca-job/description.md | 0 .../create-oneclicklca-job/displayName.md | 0 .../delete-ec3-configuration/description.md | 0 .../delete-ec3-configuration/displayName.md | 0 .../get-ec3-configuration/description.md | 0 .../get-ec3-configuration/displayName.md | 0 .../get-ec3-configurations/description.md | 0 .../get-ec3-configurations/displayName.md | 0 .../get-ec3-job-status/description.md | 0 .../get-ec3-job-status/displayName.md | 0 .../get-oneclicklca-job-status/description.md | 0 .../get-oneclicklca-job-status/displayName.md | 0 .../update-ec3-configuration/description.md | 0 .../update-ec3-configuration/displayName.md | 0 .../changed-elements/v2/description.md | 0 .../create-comparison-job/description.md | 0 .../create-comparison-job/displayName.md | 0 .../delete-comparison-job/description.md | 0 .../delete-comparison-job/displayName.md | 0 .../get-comparison-job/description.md | 0 .../get-comparison-job/displayName.md | 0 .../clash-detection/v2/description.md | 0 .../description.md | 0 .../displayName.md | 0 .../cancel-clashdetection-run/description.md | 0 .../cancel-clashdetection-run/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../delete-clashdetection-run/description.md | 0 .../delete-clashdetection-run/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../delete-clashdetection-test/description.md | 0 .../delete-clashdetection-test/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-clashdetection-result/description.md | 0 .../get-clashdetection-result/displayName.md | 0 .../get-clashdetection-results/description.md | 0 .../get-clashdetection-results/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-clashdetection-test/description.md | 0 .../get-clashdetection-test/displayName.md | 0 .../get-clashdetection-tests/description.md | 0 .../get-clashdetection-tests/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../run-clashdetection-test/description.md | 0 .../run-clashdetection-test/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../update-clashdetection-test/description.md | 0 .../update-clashdetection-test/displayName.md | 0 .../contextcapture/v1/description.md | 0 .../v1/operations/jobs-create/description.md | 0 .../v1/operations/jobs-create/displayName.md | 0 .../v1/operations/jobs-delete/description.md | 0 .../v1/operations/jobs-delete/displayName.md | 0 .../v1/operations/jobs-get/description.md | 0 .../v1/operations/jobs-get/displayName.md | 0 .../v1/operations/jobs-patch/description.md | 0 .../v1/operations/jobs-patch/displayName.md | 0 .../operations/jobs-progress/description.md | 0 .../operations/jobs-progress/displayName.md | 0 .../operations/limits-engines/description.md | 0 .../operations/limits-engines/displayName.md | 0 .../workspaces-create/description.md | 0 .../workspaces-create/displayName.md | 0 .../workspaces-delete/description.md | 0 .../workspaces-delete/displayName.md | 0 .../operations/workspaces-get/description.md | 0 .../operations/workspaces-get/displayName.md | 0 {services => apis}/echo/v2/description.md | 0 .../context-nested-parameter/description.md | 0 .../context-nested-parameter/displayName.md | 0 .../context-parameter/description.md | 0 .../context-parameter/displayName.md | 0 .../echo/v2/operations/context/description.md | 0 .../echo/v2/operations/context/displayName.md | 0 {services => apis}/export/v1/description.md | 0 .../description.md | 0 .../displayName.md | 0 .../create-export-connection/description.md | 0 .../create-export-connection/displayName.md | 0 .../delete-export-connection/description.md | 0 .../delete-export-connection/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-export-connection-run/description.md | 0 .../get-export-connection-run/displayName.md | 0 .../get-export-connection-runs/description.md | 0 .../get-export-connection-runs/displayName.md | 0 .../get-export-connection/description.md | 0 .../get-export-connection/displayName.md | 0 .../get-export-connections/description.md | 0 .../get-export-connections/displayName.md | 0 .../extensions/v1/description.md | 0 .../create-extension-version/description.md | 0 .../create-extension-version/displayName.md | 0 .../create-private-extension/description.md | 0 .../create-private-extension/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../delete-extension/description.md | 0 .../delete-extension/displayName.md | 0 .../get-extension-version/description.md | 0 .../get-extension-version/displayName.md | 0 .../get-extension-versions/description.md | 0 .../get-extension-versions/displayName.md | 0 .../operations/get-extensions/description.md | 0 .../operations/get-extensions/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../update-extension/description.md | 0 .../update-extension/displayName.md | 0 {services => apis}/forms/v1/description.md | 0 .../add-attachment-to-form/description.md | 0 .../add-attachment-to-form/displayName.md | 0 .../add-comment-to-form/description.md | 0 .../add-comment-to-form/displayName.md | 0 .../create-form-data/description.md | 0 .../create-form-data/displayName.md | 0 .../delete-attachment/description.md | 0 .../delete-attachment/displayName.md | 0 .../operations/delete-comment/description.md | 0 .../operations/delete-comment/displayName.md | 0 .../delete-form-data/description.md | 0 .../delete-form-data/displayName.md | 0 .../download-form-as-file/description.md | 0 .../download-form-as-file/displayName.md | 0 .../export-form-to-storage/description.md | 0 .../export-form-to-storage/displayName.md | 0 .../get-attachment-file-by-id/description.md | 0 .../get-attachment-file-by-id/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-form-data-attachments/description.md | 0 .../get-form-data-attachments/displayName.md | 0 .../get-form-data-comments/description.md | 0 .../get-form-data-comments/displayName.md | 0 .../get-form-data-details/description.md | 0 .../get-form-data-details/displayName.md | 0 .../get-form-definition-by-id/description.md | 0 .../get-form-definition-by-id/displayName.md | 0 .../operations/get-list-group/description.md | 0 .../operations/get-list-group/displayName.md | 0 .../get-project-form-data/description.md | 0 .../get-project-form-data/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-static-image/description.md | 0 .../get-static-image/displayName.md | 0 .../v1/operations/get-workflow/description.md | 0 .../v1/operations/get-workflow/displayName.md | 0 .../update-form-data/description.md | 0 .../update-form-data/displayName.md | 0 .../upload-attachment-file/description.md | 0 .../upload-attachment-file/displayName.md | 0 .../grouping-and-mapping/v1/description.md | 0 .../v1/operations/create-group/description.md | 0 .../v1/operations/create-group/displayName.md | 0 .../operations/create-mapping/description.md | 0 .../operations/create-mapping/displayName.md | 0 .../operations/create-property/description.md | 0 .../operations/create-property/displayName.md | 0 .../v1/operations/delete-group/description.md | 0 .../v1/operations/delete-group/displayName.md | 0 .../operations/delete-mapping/description.md | 0 .../operations/delete-mapping/displayName.md | 0 .../operations/delete-property/description.md | 0 .../operations/delete-property/displayName.md | 0 .../get-audittrail-imodel/description.md | 0 .../get-audittrail-imodel/displayName.md | 0 .../get-cdm-partition/description.md | 0 .../get-cdm-partition/displayName.md | 0 .../v1/operations/get-cdm/description.md | 0 .../v1/operations/get-cdm/displayName.md | 0 .../get-extraction-logs/description.md | 0 .../get-extraction-logs/displayName.md | 0 .../get-extraction-status/description.md | 0 .../get-extraction-status/displayName.md | 0 .../v1/operations/get-group/description.md | 0 .../v1/operations/get-group/displayName.md | 0 .../v1/operations/get-groups/description.md | 0 .../v1/operations/get-groups/displayName.md | 0 .../get-imodel-extractions/description.md | 0 .../get-imodel-extractions/displayName.md | 0 .../get-mapping-extractions/description.md | 0 .../get-mapping-extractions/displayName.md | 0 .../v1/operations/get-mapping/description.md | 0 .../v1/operations/get-mapping/displayName.md | 0 .../v1/operations/get-mappings/description.md | 0 .../v1/operations/get-mappings/displayName.md | 0 .../operations/get-properties/description.md | 0 .../operations/get-properties/displayName.md | 0 .../v1/operations/get-property/description.md | 0 .../v1/operations/get-property/displayName.md | 0 .../operations/run-extraction/description.md | 0 .../operations/run-extraction/displayName.md | 0 .../v1/operations/update-group/description.md | 0 .../v1/operations/update-group/displayName.md | 0 .../operations/update-mapping/description.md | 0 .../operations/update-mapping/displayName.md | 0 .../operations/update-property/description.md | 0 .../operations/update-property/displayName.md | 0 .../operations/rpc-version-get/description.md | 0 .../operations/rpc-version-get/displayName.md | 0 .../v1/operations/rpc-version/description.md | 0 .../v1/operations/rpc-version/displayName.md | 0 .../imodels-odata/v1/description.md | 0 .../mapping-odata-entity/description.md | 0 .../mapping-odata-entity/displayName.md | 0 .../mapping-odata-metadata/description.md | 0 .../mapping-odata-metadata/displayName.md | 0 .../operations/mapping-odata/description.md | 0 .../operations/mapping-odata/displayName.md | 0 {services => apis}/imodels/v2/description.md | 0 .../acquire-imodel-briefcase/description.md | 0 .../acquire-imodel-briefcase/displayName.md | 0 .../v2/operations/clone-imodel/description.md | 0 .../v2/operations/clone-imodel/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../create-imodel-changeset/description.md | 0 .../create-imodel-changeset/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../create-imodel-share/description.md | 0 .../create-imodel-share/displayName.md | 0 .../operations/create-imodel/description.md | 0 .../operations/create-imodel/displayName.md | 0 .../operations/delete-imodel/description.md | 0 .../operations/delete-imodel/displayName.md | 0 .../v2/operations/fork-imodel/description.md | 0 .../v2/operations/fork-imodel/displayName.md | 0 .../get-briefcase-checkpoint/description.md | 0 .../get-briefcase-checkpoint/displayName.md | 0 .../get-changeset-checkpoint/description.md | 0 .../get-changeset-checkpoint/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-imodel-briefcases/description.md | 0 .../get-imodel-briefcases/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-imodel-changesets/description.md | 0 .../get-imodel-changesets/displayName.md | 0 .../get-imodel-details/description.md | 0 .../get-imodel-details/displayName.md | 0 .../get-imodel-locks/description.md | 0 .../get-imodel-locks/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-imodel-named-versions/description.md | 0 .../get-imodel-named-versions/displayName.md | 0 .../get-imodel-permissions/description.md | 0 .../get-imodel-permissions/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-imodel-share/description.md | 0 .../get-imodel-share/displayName.md | 0 .../get-imodel-shares/description.md | 0 .../get-imodel-shares/displayName.md | 0 .../get-imodel-thumbnail/description.md | 0 .../get-imodel-thumbnail/displayName.md | 0 .../get-imodel-user-details/description.md | 0 .../get-imodel-user-details/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-imodel-users/description.md | 0 .../get-imodel-users/displayName.md | 0 .../get-itwin-imodels/description.md | 0 .../get-itwin-imodels/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../release-imodel-briefcase/description.md | 0 .../release-imodel-briefcase/displayName.md | 0 .../revoke-imodel-share/description.md | 0 .../revoke-imodel-share/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../update-imodel-changeset/description.md | 0 .../update-imodel-changeset/displayName.md | 0 .../update-imodel-locks/description.md | 0 .../update-imodel-locks/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../update-imodel-share/description.md | 0 .../update-imodel-share/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../operations/update-imodel/description.md | 0 .../operations/update-imodel/displayName.md | 0 .../upload-imodel-thumbnail/description.md | 0 .../upload-imodel-thumbnail/displayName.md | 0 {services => apis}/issues/v1/description.md | 0 .../add-attachment-to-issue/description.md | 0 .../add-attachment-to-issue/displayName.md | 0 .../add-comment-to-issue/description.md | 0 .../add-comment-to-issue/displayName.md | 0 .../v1/operations/create-issue/description.md | 0 .../v1/operations/create-issue/displayName.md | 0 .../delete-attachment/description.md | 0 .../delete-attachment/displayName.md | 0 .../operations/delete-comment/description.md | 0 .../operations/delete-comment/displayName.md | 0 .../v1/operations/delete-issue/description.md | 0 .../v1/operations/delete-issue/displayName.md | 0 .../download-issue-as-file/description.md | 0 .../download-issue-as-file/displayName.md | 0 .../export-issues-to-storage/description.md | 0 .../export-issues-to-storage/displayName.md | 0 .../get-attachment-by-id/description.md | 0 .../get-attachment-by-id/displayName.md | 0 .../get-form-definition-by-id/description.md | 0 .../get-form-definition-by-id/displayName.md | 0 .../get-issue-attachments/description.md | 0 .../get-issue-attachments/displayName.md | 0 .../get-issue-audit-trail/description.md | 0 .../get-issue-audit-trail/displayName.md | 0 .../get-issue-comments/description.md | 0 .../get-issue-comments/displayName.md | 0 .../get-issue-details/description.md | 0 .../get-issue-details/displayName.md | 0 .../operations/get-list-group/description.md | 0 .../operations/get-list-group/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-project-issues/description.md | 0 .../get-project-issues/displayName.md | 0 .../get-static-image/description.md | 0 .../get-static-image/displayName.md | 0 .../v1/operations/get-workflow/description.md | 0 .../v1/operations/get-workflow/displayName.md | 0 .../v1/operations/modify-issue/description.md | 0 .../v1/operations/modify-issue/displayName.md | 0 .../upload-attachment-file/description.md | 0 .../upload-attachment-file/displayName.md | 0 .../itwin-entities/v1/description.md | 0 .../operations/create-entity/description.md | 0 .../operations/create-entity/displayName.md | 0 .../create-hierarchy-nodes/description.md | 0 .../create-hierarchy-nodes/displayName.md | 0 .../create-hierarchy/description.md | 0 .../create-hierarchy/displayName.md | 0 .../v1/operations/create-link/description.md | 0 .../v1/operations/create-link/displayName.md | 0 .../operations/delete-entity/description.md | 0 .../operations/delete-entity/displayName.md | 0 .../delete-hierarchy-node/description.md | 0 .../delete-hierarchy-node/displayName.md | 0 .../delete-hierarchy/description.md | 0 .../delete-hierarchy/displayName.md | 0 .../v1/operations/delete-link/description.md | 0 .../v1/operations/delete-link/displayName.md | 0 .../v1/operations/get-entities/description.md | 0 .../v1/operations/get-entities/displayName.md | 0 .../v1/operations/get-entity/description.md | 0 .../v1/operations/get-entity/displayName.md | 0 .../operations/get-hierarchies/description.md | 0 .../operations/get-hierarchies/displayName.md | 0 .../get-hierarchy-nodes/description.md | 0 .../get-hierarchy-nodes/displayName.md | 0 .../operations/get-hierarchy/description.md | 0 .../operations/get-hierarchy/displayName.md | 0 .../v1/operations/get-links/description.md | 0 .../v1/operations/get-links/displayName.md | 0 .../operations/update-entity/description.md | 0 .../operations/update-entity/displayName.md | 0 .../update-hierarchy/description.md | 0 .../update-hierarchy/displayName.md | 0 .../itwin-search/v1/description.md | 0 .../v1/operations/discover/description.md | 0 .../v1/operations/discover/displayName.md | 0 .../v1/operations/post-search/description.md | 0 .../v1/operations/post-search/displayName.md | 0 {services => apis}/itwins/v1/description.md | 0 .../add-itwin-to-my-favorites/description.md | 0 .../add-itwin-to-my-favorites/displayName.md | 0 .../add-itwin-to-my-recents/description.md | 0 .../add-itwin-to-my-recents/displayName.md | 0 .../v1/operations/create-itwin/description.md | 0 .../v1/operations/create-itwin/displayName.md | 0 .../create-repository/description.md | 0 .../create-repository/displayName.md | 0 .../delete-itwin-image/description.md | 0 .../delete-itwin-image/displayName.md | 0 .../v1/operations/delete-itwin/description.md | 0 .../v1/operations/delete-itwin/displayName.md | 0 .../delete-repository/description.md | 0 .../delete-repository/displayName.md | 0 .../get-itwin-account/description.md | 0 .../get-itwin-account/displayName.md | 0 .../operations/get-itwin-image/description.md | 0 .../operations/get-itwin-image/displayName.md | 0 .../v1/operations/get-itwin/description.md | 0 .../v1/operations/get-itwin/displayName.md | 0 .../get-my-favorite-itwins/description.md | 0 .../get-my-favorite-itwins/displayName.md | 0 .../operations/get-my-itwins/description.md | 0 .../operations/get-my-itwins/displayName.md | 0 .../get-my-primary-account/description.md | 0 .../get-my-primary-account/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../v1/operations/update-itwin/description.md | 0 .../v1/operations/update-itwin/displayName.md | 0 .../upload-itwin-image/description.md | 0 .../upload-itwin-image/displayName.md | 0 {services => apis}/library/v1/description.md | 0 .../create-application/description.md | 0 .../create-application/displayName.md | 0 .../create-catalog-document/description.md | 0 .../create-catalog-document/displayName.md | 0 .../create-catalog-weblink/description.md | 0 .../create-catalog-weblink/displayName.md | 0 .../operations/create-catalog/description.md | 0 .../operations/create-catalog/displayName.md | 0 .../operations/create-category/description.md | 0 .../operations/create-category/displayName.md | 0 .../create-component-document/description.md | 0 .../create-component-document/displayName.md | 0 .../create-component-variation/description.md | 0 .../create-component-variation/displayName.md | 0 .../create-component-weblink/description.md | 0 .../create-component-weblink/displayName.md | 0 .../create-component/description.md | 0 .../create-component/displayName.md | 0 .../create-manufacturer/description.md | 0 .../create-manufacturer/displayName.md | 0 .../delete-application/description.md | 0 .../delete-application/displayName.md | 0 .../delete-catalog-document/description.md | 0 .../delete-catalog-document/displayName.md | 0 .../delete-catalog-weblink/description.md | 0 .../delete-catalog-weblink/displayName.md | 0 .../operations/delete-catalog/description.md | 0 .../operations/delete-catalog/displayName.md | 0 .../operations/delete-category/description.md | 0 .../operations/delete-category/displayName.md | 0 .../delete-component-document/description.md | 0 .../delete-component-document/displayName.md | 0 .../delete-component-variation/description.md | 0 .../delete-component-variation/displayName.md | 0 .../delete-component-weblink/description.md | 0 .../delete-component-weblink/displayName.md | 0 .../delete-component/description.md | 0 .../delete-component/displayName.md | 0 .../delete-manufacturer/description.md | 0 .../delete-manufacturer/displayName.md | 0 .../download-analytics/description.md | 0 .../download-analytics/displayName.md | 0 .../operations/get-application/description.md | 0 .../operations/get-application/displayName.md | 0 .../get-applications/description.md | 0 .../get-applications/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-brand-components/description.md | 0 .../get-brand-components/displayName.md | 0 .../v1/operations/get-brand/description.md | 0 .../v1/operations/get-brand/displayName.md | 0 .../v1/operations/get-brands/description.md | 0 .../v1/operations/get-brands/displayName.md | 0 .../get-catalog-document/description.md | 0 .../get-catalog-document/displayName.md | 0 .../get-catalog-documents/description.md | 0 .../get-catalog-documents/displayName.md | 0 .../get-catalog-weblink/description.md | 0 .../get-catalog-weblink/displayName.md | 0 .../get-catalog-weblinks/description.md | 0 .../get-catalog-weblinks/displayName.md | 0 .../v1/operations/get-catalog/description.md | 0 .../v1/operations/get-catalog/displayName.md | 0 .../v1/operations/get-catalogs/description.md | 0 .../v1/operations/get-catalogs/displayName.md | 0 .../operations/get-categories/description.md | 0 .../operations/get-categories/displayName.md | 0 .../v1/operations/get-category/description.md | 0 .../v1/operations/get-category/displayName.md | 0 .../get-component-document/description.md | 0 .../get-component-document/displayName.md | 0 .../get-component-documents/description.md | 0 .../get-component-documents/displayName.md | 0 .../get-component-variation/description.md | 0 .../get-component-variation/displayName.md | 0 .../get-component-variations/description.md | 0 .../get-component-variations/displayName.md | 0 .../get-component-weblink/description.md | 0 .../get-component-weblink/displayName.md | 0 .../get-component-weblinks/description.md | 0 .../get-component-weblinks/displayName.md | 0 .../operations/get-component/description.md | 0 .../operations/get-component/displayName.md | 0 .../operations/get-components/description.md | 0 .../operations/get-components/displayName.md | 0 .../v1/operations/get-job/description.md | 0 .../v1/operations/get-job/displayName.md | 0 .../get-manufacturer/description.md | 0 .../get-manufacturer/displayName.md | 0 .../get-manufacturers/description.md | 0 .../get-manufacturers/displayName.md | 0 .../update-application/description.md | 0 .../update-application/displayName.md | 0 .../update-catalog-document/description.md | 0 .../update-catalog-document/displayName.md | 0 .../update-catalog-weblink/description.md | 0 .../update-catalog-weblink/displayName.md | 0 .../operations/update-catalog/description.md | 0 .../operations/update-catalog/displayName.md | 0 .../operations/update-category/description.md | 0 .../operations/update-category/displayName.md | 0 .../update-component-document/description.md | 0 .../update-component-document/displayName.md | 0 .../update-component-variation/description.md | 0 .../update-component-variation/displayName.md | 0 .../update-component-weblink/description.md | 0 .../update-component-weblink/displayName.md | 0 .../update-component/description.md | 0 .../update-component/displayName.md | 0 .../update-manufacturer/description.md | 0 .../update-manufacturer/displayName.md | 0 .../upload-component/description.md | 0 .../upload-component/displayName.md | 0 .../mesh-export/v1/description.md | 0 .../operations/delete-export/description.md | 0 .../operations/delete-export/displayName.md | 0 .../v1/operations/get-export/description.md | 0 .../v1/operations/get-export/displayName.md | 0 .../v1/operations/get-exports/description.md | 0 .../v1/operations/get-exports/displayName.md | 0 .../v1/operations/start-export/description.md | 0 .../v1/operations/start-export/displayName.md | 0 .../v1/operations/create-group/description.md | 0 .../v1/operations/create-group/displayName.md | 0 .../v1/operations/delete-group/description.md | 0 .../v1/operations/delete-group/displayName.md | 0 .../v1/operations/get-group/description.md | 0 .../v1/operations/get-group/displayName.md | 0 .../get-itwin-groups/description.md | 0 .../get-itwin-groups/displayName.md | 0 .../v1/operations/update-group/description.md | 0 .../v1/operations/update-group/displayName.md | 0 .../pnid-to-itwin/v2/description.md | 0 .../create-inference-run/description.md | 0 .../create-inference-run/displayName.md | 0 .../create-inference/description.md | 0 .../create-inference/displayName.md | 0 .../delete-inference-input/description.md | 0 .../delete-inference-input/displayName.md | 0 .../delete-inference-run/description.md | 0 .../delete-inference-run/displayName.md | 0 .../delete-inference/description.md | 0 .../delete-inference/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-inference-inputs/description.md | 0 .../get-inference-inputs/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-inference-run-results/description.md | 0 .../get-inference-run-results/displayName.md | 0 .../get-inference-run/description.md | 0 .../get-inference-run/displayName.md | 0 .../operations/get-inference/description.md | 0 .../operations/get-inference/displayName.md | 0 .../get-itwin-inferences/description.md | 0 .../get-itwin-inferences/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 {services => apis}/projects/v1/description.md | 0 .../add-project-team-member/description.md | 0 .../add-project-team-member/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../add-project-to-my-recents/description.md | 0 .../add-project-to-my-recents/displayName.md | 0 .../create-project-role/description.md | 0 .../create-project-role/displayName.md | 0 .../operations/create-project/description.md | 0 .../operations/create-project/displayName.md | 0 .../delete-project-role/description.md | 0 .../delete-project-role/displayName.md | 0 .../operations/delete-project/description.md | 0 .../operations/delete-project/displayName.md | 0 .../get-my-favorite-projects/description.md | 0 .../get-my-favorite-projects/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-project-roles/description.md | 0 .../get-project-roles/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-project-team-members/description.md | 0 .../get-project-team-members/displayName.md | 0 .../v1/operations/get-project/description.md | 0 .../v1/operations/get-project/displayName.md | 0 .../get-user-permissions/description.md | 0 .../get-user-permissions/displayName.md | 0 .../v1/operations/my-projects/description.md | 0 .../v1/operations/my-projects/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../remove-project-team-member/description.md | 0 .../remove-project-team-member/displayName.md | 0 .../update-project-role/description.md | 0 .../update-project-role/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../operations/update-project/description.md | 0 .../operations/update-project/displayName.md | 0 .../projectwise365-insights/v1/description.md | 0 .../project-metadata/description.md | 0 .../project-metadata/displayName.md | 0 .../operations/project-odata/description.md | 0 .../operations/project-odata/displayName.md | 0 .../operations/project-schema/description.md | 0 .../operations/project-schema/displayName.md | 0 .../reality-data/v1/description.md | 0 .../associate-to-project/description.md | 0 .../associate-to-project/displayName.md | 0 .../create-reality-data/description.md | 0 .../create-reality-data/displayName.md | 0 .../delete-reality-data/description.md | 0 .../delete-reality-data/displayName.md | 0 .../dissociate-from-project/description.md | 0 .../dissociate-from-project/displayName.md | 0 .../get-all-reality-data/description.md | 0 .../get-all-reality-data/displayName.md | 0 .../get-reality-data-container/description.md | 0 .../get-reality-data-container/displayName.md | 0 .../get-reality-data-details/description.md | 0 .../get-reality-data-details/displayName.md | 0 .../get-reality-data-projects/description.md | 0 .../get-reality-data-projects/displayName.md | 0 .../update-reality-data/description.md | 0 .../update-reality-data/displayName.md | 0 .../reality-management/v1/description.md | 0 .../associate-to-iTwin/description.md | 0 .../associate-to-iTwin/displayName.md | 0 .../create-reality-data/description.md | 0 .../create-reality-data/displayName.md | 0 .../delete-reality-data/description.md | 0 .../delete-reality-data/displayName.md | 0 .../dissociate-from-iTwin/description.md | 0 .../dissociate-from-iTwin/displayName.md | 0 .../get-all-reality-data/description.md | 0 .../get-all-reality-data/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-reality-data-details/description.md | 0 .../get-reality-data-details/displayName.md | 0 .../get-reality-data-iTwins/description.md | 0 .../get-reality-data-iTwins/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../update-reality-data/description.md | 0 .../update-reality-data/displayName.md | 0 .../realityconversion/v1/description.md | 0 .../v1/operations/jobs-create/description.md | 0 .../v1/operations/jobs-create/displayName.md | 0 .../v1/operations/jobs-delete/description.md | 0 .../v1/operations/jobs-delete/displayName.md | 0 .../v1/operations/jobs-get/description.md | 0 .../v1/operations/jobs-get/displayName.md | 0 .../v1/operations/jobs-patch/description.md | 0 .../v1/operations/jobs-patch/displayName.md | 0 .../operations/jobs-progress/description.md | 0 .../operations/jobs-progress/displayName.md | 0 .../realitydataanalysis/v1/description.md | 0 .../v1/operations/jobs-create/description.md | 0 .../v1/operations/jobs-create/displayName.md | 0 .../v1/operations/jobs-delete/description.md | 0 .../v1/operations/jobs-delete/displayName.md | 0 .../v1/operations/jobs-get-all/description.md | 0 .../v1/operations/jobs-get-all/displayName.md | 0 .../v1/operations/jobs-get/description.md | 0 .../v1/operations/jobs-get/displayName.md | 0 .../v1/operations/jobs-patch/description.md | 0 .../v1/operations/jobs-patch/displayName.md | 0 .../operations/jobs-progress/description.md | 0 .../operations/jobs-progress/displayName.md | 0 .../reporting/v2/description.md | 0 .../operations/create-apikey/description.md | 0 .../operations/create-apikey/displayName.md | 0 .../create-report-mapping/description.md | 0 .../create-report-mapping/displayName.md | 0 .../operations/create-report/description.md | 0 .../operations/create-report/displayName.md | 0 .../delete-report-mapping/description.md | 0 .../delete-report-mapping/displayName.md | 0 .../operations/delete-report/description.md | 0 .../operations/delete-report/displayName.md | 0 .../v2/operations/get-apikey/description.md | 0 .../v2/operations/get-apikey/displayName.md | 0 .../v2/operations/get-apikeys/description.md | 0 .../v2/operations/get-apikeys/displayName.md | 0 .../get-itwin-reports/description.md | 0 .../get-itwin-reports/displayName.md | 0 .../get-report-mappings/description.md | 0 .../get-report-mappings/displayName.md | 0 .../v2/operations/get-report/description.md | 0 .../v2/operations/get-report/displayName.md | 0 .../v2/operations/odata-entity/description.md | 0 .../v2/operations/odata-entity/displayName.md | 0 .../operations/odata-metadata/description.md | 0 .../operations/odata-metadata/displayName.md | 0 .../v2/operations/odata/description.md | 0 .../v2/operations/odata/displayName.md | 0 .../operations/revoke-apikey/description.md | 0 .../operations/revoke-apikey/displayName.md | 0 .../operations/update-apikey/description.md | 0 .../operations/update-apikey/displayName.md | 0 .../operations/update-report/description.md | 0 .../operations/update-report/displayName.md | 0 .../savedviews/v1/description.md | 0 .../v1/operations/add-image/description.md | 0 .../v1/operations/add-image/displayName.md | 0 .../create-extension/description.md | 0 .../create-extension/displayName.md | 0 .../v1/operations/create-group/description.md | 0 .../v1/operations/create-group/displayName.md | 0 .../create-savedview/description.md | 0 .../create-savedview/displayName.md | 0 .../v1/operations/create-tag/description.md | 0 .../v1/operations/create-tag/displayName.md | 0 .../delete-extension/description.md | 0 .../delete-extension/displayName.md | 0 .../v1/operations/delete-group/description.md | 0 .../v1/operations/delete-group/displayName.md | 0 .../delete-savedview/description.md | 0 .../delete-savedview/displayName.md | 0 .../v1/operations/delete-tag/description.md | 0 .../v1/operations/delete-tag/displayName.md | 0 .../get-all-extensions/description.md | 0 .../get-all-extensions/displayName.md | 0 .../operations/get-all-groups/description.md | 0 .../operations/get-all-groups/displayName.md | 0 .../get-all-savedviews/description.md | 0 .../get-all-savedviews/displayName.md | 0 .../v1/operations/get-all-tags/description.md | 0 .../v1/operations/get-all-tags/displayName.md | 0 .../operations/get-extension/description.md | 0 .../operations/get-extension/displayName.md | 0 .../v1/operations/get-group/description.md | 0 .../v1/operations/get-group/displayName.md | 0 .../v1/operations/get-image/description.md | 0 .../v1/operations/get-image/displayName.md | 0 .../operations/get-savedview/description.md | 0 .../operations/get-savedview/displayName.md | 0 .../v1/operations/get-tag/description.md | 0 .../v1/operations/get-tag/displayName.md | 0 .../v1/operations/update-group/description.md | 0 .../v1/operations/update-group/displayName.md | 0 .../update-savedview/description.md | 0 .../update-savedview/displayName.md | 0 .../v1/operations/update-tag/description.md | 0 .../v1/operations/update-tag/displayName.md | 0 .../sensor-data/v1/description.md | 0 .../v1/operations/get-nodes/description.md | 0 .../v1/operations/get-nodes/displayName.md | 0 .../process-integration/description.md | 0 .../process-integration/displayName.md | 0 .../operations/query-raw-data/description.md | 0 .../operations/query-raw-data/displayName.md | 0 .../v1/operations/remove-data/description.md | 0 .../v1/operations/remove-data/displayName.md | 0 .../v1/operations/upload-data/description.md | 0 .../v1/operations/upload-data/displayName.md | 0 .../storage-container/v1/description.md | 0 .../clone-storage-container/description.md | 0 .../clone-storage-container/displayName.md | 0 .../create-storage-container/description.md | 0 .../create-storage-container/displayName.md | 0 .../delete-storage-container/description.md | 0 .../delete-storage-container/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-storage-containers/description.md | 0 .../get-storage-containers/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 {services => apis}/storage/v1/description.md | 0 .../complete-file-creation/description.md | 0 .../complete-file-creation/displayName.md | 0 .../v1/operations/create-file/description.md | 0 .../v1/operations/create-file/displayName.md | 0 .../operations/create-folder/description.md | 0 .../operations/create-folder/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../v1/operations/delete-file/description.md | 0 .../v1/operations/delete-file/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../operations/delete-folder/description.md | 0 .../operations/delete-folder/displayName.md | 0 .../operations/download-file/description.md | 0 .../operations/download-file/displayName.md | 0 .../v1/operations/get-file/description.md | 0 .../v1/operations/get-file/displayName.md | 0 .../get-files-in-folder/description.md | 0 .../get-files-in-folder/displayName.md | 0 .../v1/operations/get-folder/description.md | 0 .../v1/operations/get-folder/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-folders-in-folder/description.md | 0 .../get-folders-in-folder/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../lock-files-in-folder/description.md | 0 .../lock-files-in-folder/displayName.md | 0 .../move-file-legacy/description.md | 0 .../move-file-legacy/displayName.md | 0 .../v1/operations/move-file/description.md | 0 .../v1/operations/move-file/displayName.md | 0 .../v1/operations/move-folder/description.md | 0 .../v1/operations/move-folder/displayName.md | 0 .../v1/operations/restore-file/description.md | 0 .../v1/operations/restore-file/displayName.md | 0 .../operations/restore-folder/description.md | 0 .../operations/restore-folder/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../unlock-files-in-folder/description.md | 0 .../unlock-files-in-folder/displayName.md | 0 .../update-file-content/description.md | 0 .../update-file-content/displayName.md | 0 .../v1/operations/update-file/description.md | 0 .../v1/operations/update-file/displayName.md | 0 .../operations/update-folder/description.md | 0 .../operations/update-folder/displayName.md | 0 .../synchronization/v1/description.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../create-itwin-configuration/description.md | 0 .../create-itwin-configuration/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../create-manifest-connection/description.md | 0 .../create-manifest-connection/displayName.md | 0 .../create-storage-connection/description.md | 0 .../create-storage-connection/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../delete-itwin-configuration/description.md | 0 .../delete-itwin-configuration/displayName.md | 0 .../delete-manifest-connection/description.md | 0 .../delete-manifest-connection/displayName.md | 0 .../delete-storage-connection/description.md | 0 .../delete-storage-connection/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../operations/get-connections/description.md | 0 .../operations/get-connections/displayName.md | 0 .../get-imodel-configuration/description.md | 0 .../get-imodel-configuration/displayName.md | 0 .../get-itwin-configuration/description.md | 0 .../get-itwin-configuration/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-manifest-connection/description.md | 0 .../get-manifest-connection/displayName.md | 0 .../get-manifest-connections/description.md | 0 .../get-manifest-connections/displayName.md | 0 .../get-storage-connection-run/description.md | 0 .../get-storage-connection-run/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../get-storage-connection/description.md | 0 .../get-storage-connection/displayName.md | 0 .../get-storage-connections/description.md | 0 .../get-storage-connections/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../patch-imodel-configuration/description.md | 0 .../patch-imodel-configuration/displayName.md | 0 .../patch-itwin-configuration/description.md | 0 .../patch-itwin-configuration/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../run-storage-connection/description.md | 0 .../run-storage-connection/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../update-manifest-connection/description.md | 0 .../update-manifest-connection/displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../update-storage-connection/description.md | 0 .../update-storage-connection/displayName.md | 0 .../transformations/v1/description.md | 0 .../operations/alignimodeldata/description.md | 0 .../operations/alignimodeldata/displayName.md | 0 .../operations/combineimodels/description.md | 0 .../operations/combineimodels/displayName.md | 0 .../combinephysicalmodels/description.md | 0 .../combinephysicalmodels/displayName.md | 0 .../combinephysicalmodelsv2/description.md | 0 .../combinephysicalmodelsv2/displayName.md | 0 .../create-transformation/description.md | 0 .../create-transformation/displayName.md | 0 .../v1/operations/createfork/description.md | 0 .../v1/operations/createfork/displayName.md | 0 .../delete-configuration/description.md | 0 .../delete-configuration/displayName.md | 0 .../delete-transformation/description.md | 0 .../delete-transformation/displayName.md | 0 .../filterbyviewdefinition/description.md | 0 .../filterbyviewdefinition/displayName.md | 0 .../v1/operations/filterimodel/description.md | 0 .../v1/operations/filterimodel/displayName.md | 0 .../filtersubcategories/description.md | 0 .../filtersubcategories/displayName.md | 0 .../get-all-configurations/description.md | 0 .../get-all-configurations/displayName.md | 0 .../get-all-transformations/description.md | 0 .../get-all-transformations/displayName.md | 0 .../get-configuration/description.md | 0 .../get-configuration/displayName.md | 0 .../get-transformation/description.md | 0 .../get-transformation/displayName.md | 0 .../v1/operations/groupandmap/description.md | 0 .../v1/operations/groupandmap/displayName.md | 0 .../v1/operations/importimodel/description.md | 0 .../v1/operations/importimodel/displayName.md | 0 .../v1/operations/mergefork/description.md | 0 .../v1/operations/mergefork/displayName.md | 0 .../v1/operations/mergeimodel/description.md | 0 .../v1/operations/mergeimodel/displayName.md | 0 .../populatefederationguids/description.md | 0 .../populatefederationguids/displayName.md | 0 {services => apis}/users/v1/description.md | 0 .../v1/operations/get-user/description.md | 0 .../v1/operations/get-user/displayName.md | 0 .../get-users-by-id-list/description.md | 0 .../get-users-by-id-list/displayName.md | 0 .../v1/operations/get-users/description.md | 0 .../v1/operations/get-users/displayName.md | 0 .../users/v1/operations/me/description.md | 0 .../users/v1/operations/me/displayName.md | 0 .../access-control => apis}/v2/description.md | 0 .../add-itwin-group-members/description.md | 0 .../add-itwin-group-members/displayName.md | 1 + .../add-itwin-owner-member/description.md | 0 .../add-itwin-owner-member/displayName.md | 1 + .../add-itwin-user-members/description.md | 0 .../add-itwin-user-members/displayName.md | 1 + .../create-iTwin-role/description.md | 0 .../create-iTwin-role/displayName.md | 1 + .../create-itwin-group/description.md | 0 .../create-itwin-group/displayName.md | 1 + .../create-itwin-job/description.md | 0 .../create-itwin-job/displayName.md | 1 + .../delete-iTwin-role/description.md | 0 .../delete-iTwin-role/displayName.md | 1 + .../delete-itwin-group/description.md | 0 .../delete-itwin-group/displayName.md | 1 + .../get-all-permissions/description.md | 0 .../get-all-permissions/displayName.md | 1 + .../get-iTwin-permissions/description.md | 0 .../get-iTwin-permissions/displayName.md | 1 + .../operations/get-iTwin-roles/description.md | 0 .../operations/get-iTwin-roles/displayName.md | 1 + .../get-itwin-group-member/description.md | 0 .../get-itwin-group-member/displayName.md | 1 + .../get-itwin-group-members/description.md | 0 .../get-itwin-group-members/displayName.md | 1 + .../operations/get-itwin-group/description.md | 0 .../operations/get-itwin-group/displayName.md | 1 + .../get-itwin-groups/description.md | 0 .../get-itwin-groups/displayName.md | 1 + .../get-itwin-job-actions/description.md | 0 .../get-itwin-job-actions/displayName.md | 1 + .../operations/get-itwin-job/description.md | 0 .../operations/get-itwin-job/displayName.md | 1 + .../description.md | 0 .../displayName.md | 1 + .../get-itwin-owner-members/description.md | 0 .../get-itwin-owner-members/displayName.md | 1 + .../operations/get-itwin-role/description.md | 0 .../operations/get-itwin-role/displayName.md | 1 + .../get-itwin-user-member/description.md | 0 .../get-itwin-user-member/displayName.md | 1 + .../get-itwin-user-members/description.md | 0 .../get-itwin-user-members/displayName.md | 1 + .../remove-itwin-group-member/description.md | 0 .../remove-itwin-group-member/displayName.md | 1 + .../remove-itwin-owner-member/description.md | 0 .../remove-itwin-owner-member/displayName.md | 1 + .../remove-itwin-user-member/description.md | 0 .../remove-itwin-user-member/displayName.md | 1 + .../update-iTwin-role/description.md | 0 .../update-iTwin-role/displayName.md | 1 + .../update-itwin-group-member/description.md | 0 .../update-itwin-group-member/displayName.md | 1 + .../update-itwin-group/description.md | 0 .../update-itwin-group/displayName.md | 1 + .../update-itwin-user-member/description.md | 0 .../update-itwin-user-member/displayName.md | 1 + .../validation/v1/description.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 .../description.md | 0 .../displayName.md | 0 {services => apis}/webhooks/v2/description.md | 0 .../operations/create-webhook/description.md | 0 .../operations/create-webhook/displayName.md | 0 .../operations/delete-webhook/description.md | 0 .../operations/delete-webhook/displayName.md | 0 .../v2/operations/get-webhook/description.md | 0 .../v2/operations/get-webhook/displayName.md | 0 .../v2/operations/get-webhooks/description.md | 0 .../v2/operations/get-webhooks/displayName.md | 0 .../operations/update-webhook/description.md | 0 .../operations/update-webhook/displayName.md | 0 .../operations/description/Authorization.md | 0 .../description/OrganizationAdministrator.md | 0 .../description/ProjectsDeprecated.md | 0 .../operations/description/RateLimits.md | 0 .../operations/description/RbacPermissions.md | 0 .../description/iTwinsRBACPermission.md | 0 1174 files changed, 623 insertions(+) create mode 100644 apis/access-control/v2/description.md create mode 100644 apis/access-control/v2/operations/add-itwin-group-members/description.md rename {services => apis}/access-control/v2/operations/add-itwin-group-members/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/add-itwin-owner-member/description.md rename {services => apis}/access-control/v2/operations/add-itwin-owner-member/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/add-itwin-user-members/description.md rename {services => apis}/access-control/v2/operations/add-itwin-user-members/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/create-iTwin-role/description.md rename {services => apis}/access-control/v2/operations/create-iTwin-role/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/create-itwin-group/description.md rename {services => apis}/access-control/v2/operations/create-itwin-group/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/create-itwin-job/description.md rename {services => apis}/access-control/v2/operations/create-itwin-job/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/delete-iTwin-role/description.md rename {services => apis}/access-control/v2/operations/delete-iTwin-role/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/delete-itwin-group/description.md rename {services => apis}/access-control/v2/operations/delete-itwin-group/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-all-permissions/description.md rename {services => apis}/access-control/v2/operations/get-all-permissions/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-iTwin-permissions/description.md rename {services => apis}/access-control/v2/operations/get-iTwin-permissions/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-iTwin-roles/description.md rename {services => apis}/access-control/v2/operations/get-iTwin-roles/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-itwin-group-member/description.md rename {services => apis}/access-control/v2/operations/get-itwin-group-member/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-itwin-group-members/description.md rename {services => apis}/access-control/v2/operations/get-itwin-group-members/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-itwin-group/description.md rename {services => apis}/access-control/v2/operations/get-itwin-group/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-itwin-groups/description.md rename {services => apis}/access-control/v2/operations/get-itwin-groups/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-itwin-job-actions/description.md rename {services => apis}/access-control/v2/operations/get-itwin-job-actions/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-itwin-job/description.md rename {services => apis}/access-control/v2/operations/get-itwin-job/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-itwin-member-invitations/description.md rename {services => apis}/access-control/v2/operations/get-itwin-member-invitations/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-itwin-owner-members/description.md rename {services => apis}/access-control/v2/operations/get-itwin-owner-members/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-itwin-role/description.md rename {services => apis}/access-control/v2/operations/get-itwin-role/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-itwin-user-member/description.md rename {services => apis}/access-control/v2/operations/get-itwin-user-member/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/get-itwin-user-members/description.md rename {services => apis}/access-control/v2/operations/get-itwin-user-members/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/remove-itwin-group-member/description.md rename {services => apis}/access-control/v2/operations/remove-itwin-group-member/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/remove-itwin-owner-member/description.md rename {services => apis}/access-control/v2/operations/remove-itwin-owner-member/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/remove-itwin-user-member/description.md rename {services => apis}/access-control/v2/operations/remove-itwin-user-member/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/update-iTwin-role/description.md rename {services => apis}/access-control/v2/operations/update-iTwin-role/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/update-itwin-group-member/description.md rename {services => apis}/access-control/v2/operations/update-itwin-group-member/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/update-itwin-group/description.md rename {services => apis}/access-control/v2/operations/update-itwin-group/displayName.md (100%) create mode 100644 apis/access-control/v2/operations/update-itwin-user-member/description.md rename {services => apis}/access-control/v2/operations/update-itwin-user-member/displayName.md (100%) rename {services => apis}/carbon-calculation/v1/description.md (100%) rename {services => apis}/carbon-calculation/v1/operations/create-ec3-configuration/description.md (100%) rename {services => apis}/carbon-calculation/v1/operations/create-ec3-configuration/displayName.md (100%) rename {services => apis}/carbon-calculation/v1/operations/create-ec3-job/description.md (100%) rename {services => apis}/carbon-calculation/v1/operations/create-ec3-job/displayName.md (100%) rename {services => apis}/carbon-calculation/v1/operations/create-oneclicklca-job/description.md (100%) rename {services => apis}/carbon-calculation/v1/operations/create-oneclicklca-job/displayName.md (100%) rename {services => apis}/carbon-calculation/v1/operations/delete-ec3-configuration/description.md (100%) rename {services => apis}/carbon-calculation/v1/operations/delete-ec3-configuration/displayName.md (100%) rename {services => apis}/carbon-calculation/v1/operations/get-ec3-configuration/description.md (100%) rename {services => apis}/carbon-calculation/v1/operations/get-ec3-configuration/displayName.md (100%) rename {services => apis}/carbon-calculation/v1/operations/get-ec3-configurations/description.md (100%) rename {services => apis}/carbon-calculation/v1/operations/get-ec3-configurations/displayName.md (100%) rename {services => apis}/carbon-calculation/v1/operations/get-ec3-job-status/description.md (100%) rename {services => apis}/carbon-calculation/v1/operations/get-ec3-job-status/displayName.md (100%) rename {services => apis}/carbon-calculation/v1/operations/get-oneclicklca-job-status/description.md (100%) rename {services => apis}/carbon-calculation/v1/operations/get-oneclicklca-job-status/displayName.md (100%) rename {services => apis}/carbon-calculation/v1/operations/update-ec3-configuration/description.md (100%) rename {services => apis}/carbon-calculation/v1/operations/update-ec3-configuration/displayName.md (100%) rename {services => apis}/changed-elements/v2/description.md (100%) rename {services => apis}/changed-elements/v2/operations/create-comparison-job/description.md (100%) rename {services => apis}/changed-elements/v2/operations/create-comparison-job/displayName.md (100%) rename {services => apis}/changed-elements/v2/operations/delete-comparison-job/description.md (100%) rename {services => apis}/changed-elements/v2/operations/delete-comparison-job/displayName.md (100%) rename {services => apis}/changed-elements/v2/operations/get-comparison-job/description.md (100%) rename {services => apis}/changed-elements/v2/operations/get-comparison-job/displayName.md (100%) rename {services => apis}/clash-detection/v2/description.md (100%) rename {services => apis}/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/description.md (100%) rename {services => apis}/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/cancel-clashdetection-run/description.md (100%) rename {services => apis}/clash-detection/v2/operations/cancel-clashdetection-run/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/create-clashdetection-suppression-rule/description.md (100%) rename {services => apis}/clash-detection/v2/operations/create-clashdetection-suppression-rule/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/create-clashdetection-tests/description.md (100%) rename {services => apis}/clash-detection/v2/operations/create-clashdetection-tests/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/delete-clashdetection-run/description.md (100%) rename {services => apis}/clash-detection/v2/operations/delete-clashdetection-run/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/delete-clashdetection-suppression-rule/description.md (100%) rename {services => apis}/clash-detection/v2/operations/delete-clashdetection-suppression-rule/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/delete-clashdetection-test/description.md (100%) rename {services => apis}/clash-detection/v2/operations/delete-clashdetection-test/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/description.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-result/description.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-result/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-results/description.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-results/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-suppression-rule/description.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-suppression-rule/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-suppression-rules/description.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-suppression-rules/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-test/description.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-test/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-tests/description.md (100%) rename {services => apis}/clash-detection/v2/operations/get-clashdetection-tests/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/get-suppression-rule-templates/description.md (100%) rename {services => apis}/clash-detection/v2/operations/get-suppression-rule-templates/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/description.md (100%) rename {services => apis}/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/run-clashdetection-test/description.md (100%) rename {services => apis}/clash-detection/v2/operations/run-clashdetection-test/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/update-clashdetection-suppression-rule/description.md (100%) rename {services => apis}/clash-detection/v2/operations/update-clashdetection-suppression-rule/displayName.md (100%) rename {services => apis}/clash-detection/v2/operations/update-clashdetection-test/description.md (100%) rename {services => apis}/clash-detection/v2/operations/update-clashdetection-test/displayName.md (100%) rename {services => apis}/contextcapture/v1/description.md (100%) rename {services => apis}/contextcapture/v1/operations/jobs-create/description.md (100%) rename {services => apis}/contextcapture/v1/operations/jobs-create/displayName.md (100%) rename {services => apis}/contextcapture/v1/operations/jobs-delete/description.md (100%) rename {services => apis}/contextcapture/v1/operations/jobs-delete/displayName.md (100%) rename {services => apis}/contextcapture/v1/operations/jobs-get/description.md (100%) rename {services => apis}/contextcapture/v1/operations/jobs-get/displayName.md (100%) rename {services => apis}/contextcapture/v1/operations/jobs-patch/description.md (100%) rename {services => apis}/contextcapture/v1/operations/jobs-patch/displayName.md (100%) rename {services => apis}/contextcapture/v1/operations/jobs-progress/description.md (100%) rename {services => apis}/contextcapture/v1/operations/jobs-progress/displayName.md (100%) rename {services => apis}/contextcapture/v1/operations/limits-engines/description.md (100%) rename {services => apis}/contextcapture/v1/operations/limits-engines/displayName.md (100%) rename {services => apis}/contextcapture/v1/operations/workspaces-create/description.md (100%) rename {services => apis}/contextcapture/v1/operations/workspaces-create/displayName.md (100%) rename {services => apis}/contextcapture/v1/operations/workspaces-delete/description.md (100%) rename {services => apis}/contextcapture/v1/operations/workspaces-delete/displayName.md (100%) rename {services => apis}/contextcapture/v1/operations/workspaces-get/description.md (100%) rename {services => apis}/contextcapture/v1/operations/workspaces-get/displayName.md (100%) rename {services => apis}/echo/v2/description.md (100%) rename {services => apis}/echo/v2/operations/context-nested-parameter/description.md (100%) rename {services => apis}/echo/v2/operations/context-nested-parameter/displayName.md (100%) rename {services => apis}/echo/v2/operations/context-parameter/description.md (100%) rename {services => apis}/echo/v2/operations/context-parameter/displayName.md (100%) rename {services => apis}/echo/v2/operations/context/description.md (100%) rename {services => apis}/echo/v2/operations/context/displayName.md (100%) rename {services => apis}/export/v1/description.md (100%) rename {services => apis}/export/v1/operations/create-export-connection-run/description.md (100%) rename {services => apis}/export/v1/operations/create-export-connection-run/displayName.md (100%) rename {services => apis}/export/v1/operations/create-export-connection/description.md (100%) rename {services => apis}/export/v1/operations/create-export-connection/displayName.md (100%) rename {services => apis}/export/v1/operations/delete-export-connection/description.md (100%) rename {services => apis}/export/v1/operations/delete-export-connection/displayName.md (100%) rename {services => apis}/export/v1/operations/get-authorizationinformation/description.md (100%) rename {services => apis}/export/v1/operations/get-authorizationinformation/displayName.md (100%) rename {services => apis}/export/v1/operations/get-export-connection-run/description.md (100%) rename {services => apis}/export/v1/operations/get-export-connection-run/displayName.md (100%) rename {services => apis}/export/v1/operations/get-export-connection-runs/description.md (100%) rename {services => apis}/export/v1/operations/get-export-connection-runs/displayName.md (100%) rename {services => apis}/export/v1/operations/get-export-connection/description.md (100%) rename {services => apis}/export/v1/operations/get-export-connection/displayName.md (100%) rename {services => apis}/export/v1/operations/get-export-connections/description.md (100%) rename {services => apis}/export/v1/operations/get-export-connections/displayName.md (100%) rename {services => apis}/extensions/v1/description.md (100%) rename {services => apis}/extensions/v1/operations/create-extension-version/description.md (100%) rename {services => apis}/extensions/v1/operations/create-extension-version/displayName.md (100%) rename {services => apis}/extensions/v1/operations/create-private-extension/description.md (100%) rename {services => apis}/extensions/v1/operations/create-private-extension/displayName.md (100%) rename {services => apis}/extensions/v1/operations/create-public-itwin-studio-app/description.md (100%) rename {services => apis}/extensions/v1/operations/create-public-itwin-studio-app/displayName.md (100%) rename {services => apis}/extensions/v1/operations/delete-extension/description.md (100%) rename {services => apis}/extensions/v1/operations/delete-extension/displayName.md (100%) rename {services => apis}/extensions/v1/operations/get-extension-version/description.md (100%) rename {services => apis}/extensions/v1/operations/get-extension-version/displayName.md (100%) rename {services => apis}/extensions/v1/operations/get-extension-versions/description.md (100%) rename {services => apis}/extensions/v1/operations/get-extension-versions/displayName.md (100%) rename {services => apis}/extensions/v1/operations/get-extensions/description.md (100%) rename {services => apis}/extensions/v1/operations/get-extensions/displayName.md (100%) rename {services => apis}/extensions/v1/operations/get-latest-extension-version/description.md (100%) rename {services => apis}/extensions/v1/operations/get-latest-extension-version/displayName.md (100%) rename {services => apis}/extensions/v1/operations/update-extension/description.md (100%) rename {services => apis}/extensions/v1/operations/update-extension/displayName.md (100%) rename {services => apis}/forms/v1/description.md (100%) rename {services => apis}/forms/v1/operations/add-attachment-to-form/description.md (100%) rename {services => apis}/forms/v1/operations/add-attachment-to-form/displayName.md (100%) rename {services => apis}/forms/v1/operations/add-comment-to-form/description.md (100%) rename {services => apis}/forms/v1/operations/add-comment-to-form/displayName.md (100%) rename {services => apis}/forms/v1/operations/create-form-data/description.md (100%) rename {services => apis}/forms/v1/operations/create-form-data/displayName.md (100%) rename {services => apis}/forms/v1/operations/delete-attachment/description.md (100%) rename {services => apis}/forms/v1/operations/delete-attachment/displayName.md (100%) rename {services => apis}/forms/v1/operations/delete-comment/description.md (100%) rename {services => apis}/forms/v1/operations/delete-comment/displayName.md (100%) rename {services => apis}/forms/v1/operations/delete-form-data/description.md (100%) rename {services => apis}/forms/v1/operations/delete-form-data/displayName.md (100%) rename {services => apis}/forms/v1/operations/download-form-as-file/description.md (100%) rename {services => apis}/forms/v1/operations/download-form-as-file/displayName.md (100%) rename {services => apis}/forms/v1/operations/export-form-to-storage/description.md (100%) rename {services => apis}/forms/v1/operations/export-form-to-storage/displayName.md (100%) rename {services => apis}/forms/v1/operations/get-attachment-file-by-id/description.md (100%) rename {services => apis}/forms/v1/operations/get-attachment-file-by-id/displayName.md (100%) rename {services => apis}/forms/v1/operations/get-audit-trail-for-form-data/description.md (100%) rename {services => apis}/forms/v1/operations/get-audit-trail-for-form-data/displayName.md (100%) rename {services => apis}/forms/v1/operations/get-form-data-attachments/description.md (100%) rename {services => apis}/forms/v1/operations/get-form-data-attachments/displayName.md (100%) rename {services => apis}/forms/v1/operations/get-form-data-comments/description.md (100%) rename {services => apis}/forms/v1/operations/get-form-data-comments/displayName.md (100%) rename {services => apis}/forms/v1/operations/get-form-data-details/description.md (100%) rename {services => apis}/forms/v1/operations/get-form-data-details/displayName.md (100%) rename {services => apis}/forms/v1/operations/get-form-definition-by-id/description.md (100%) rename {services => apis}/forms/v1/operations/get-form-definition-by-id/displayName.md (100%) rename {services => apis}/forms/v1/operations/get-list-group/description.md (100%) rename {services => apis}/forms/v1/operations/get-list-group/displayName.md (100%) rename {services => apis}/forms/v1/operations/get-project-form-data/description.md (100%) rename {services => apis}/forms/v1/operations/get-project-form-data/displayName.md (100%) rename {services => apis}/forms/v1/operations/get-project-form-definitions/description.md (100%) rename {services => apis}/forms/v1/operations/get-project-form-definitions/displayName.md (100%) rename {services => apis}/forms/v1/operations/get-static-image/description.md (100%) rename {services => apis}/forms/v1/operations/get-static-image/displayName.md (100%) rename {services => apis}/forms/v1/operations/get-workflow/description.md (100%) rename {services => apis}/forms/v1/operations/get-workflow/displayName.md (100%) rename {services => apis}/forms/v1/operations/update-form-data/description.md (100%) rename {services => apis}/forms/v1/operations/update-form-data/displayName.md (100%) rename {services => apis}/forms/v1/operations/upload-attachment-file/description.md (100%) rename {services => apis}/forms/v1/operations/upload-attachment-file/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/create-group/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/create-group/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/create-mapping/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/create-mapping/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/create-property/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/create-property/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/delete-group/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/delete-group/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/delete-mapping/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/delete-mapping/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/delete-property/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/delete-property/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-audittrail-imodel/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-audittrail-imodel/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-cdm-partition/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-cdm-partition/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-cdm/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-cdm/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-extraction-logs/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-extraction-logs/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-extraction-status/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-extraction-status/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-group/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-group/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-groups/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-groups/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-imodel-extractions/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-imodel-extractions/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-mapping-extractions/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-mapping-extractions/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-mapping/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-mapping/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-mappings/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-mappings/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-properties/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-properties/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-property/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/get-property/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/run-extraction/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/run-extraction/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/update-group/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/update-group/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/update-mapping/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/update-mapping/displayName.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/update-property/description.md (100%) rename {services => apis}/grouping-and-mapping/v1/operations/update-property/displayName.md (100%) rename {services => apis}/imodel-rpc/v1/operations/rpc-version-get/description.md (100%) rename {services => apis}/imodel-rpc/v1/operations/rpc-version-get/displayName.md (100%) rename {services => apis}/imodel-rpc/v1/operations/rpc-version/description.md (100%) rename {services => apis}/imodel-rpc/v1/operations/rpc-version/displayName.md (100%) rename {services => apis}/imodels-odata/v1/description.md (100%) rename {services => apis}/imodels-odata/v1/operations/mapping-odata-entity/description.md (100%) rename {services => apis}/imodels-odata/v1/operations/mapping-odata-entity/displayName.md (100%) rename {services => apis}/imodels-odata/v1/operations/mapping-odata-metadata/description.md (100%) rename {services => apis}/imodels-odata/v1/operations/mapping-odata-metadata/displayName.md (100%) rename {services => apis}/imodels-odata/v1/operations/mapping-odata/description.md (100%) rename {services => apis}/imodels-odata/v1/operations/mapping-odata/displayName.md (100%) rename {services => apis}/imodels/v2/description.md (100%) rename {services => apis}/imodels/v2/operations/acquire-imodel-briefcase/description.md (100%) rename {services => apis}/imodels/v2/operations/acquire-imodel-briefcase/displayName.md (100%) rename {services => apis}/imodels/v2/operations/clone-imodel/description.md (100%) rename {services => apis}/imodels/v2/operations/clone-imodel/displayName.md (100%) rename {services => apis}/imodels/v2/operations/complete-imodel-baseline-file-upload/description.md (100%) rename {services => apis}/imodels/v2/operations/complete-imodel-baseline-file-upload/displayName.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel-changeset-extended-data/description.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel-changeset-extended-data/displayName.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel-changeset-group/description.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel-changeset-group/displayName.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel-changeset/description.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel-changeset/displayName.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel-named-version/description.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel-named-version/displayName.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel-share/description.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel-share/displayName.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel/description.md (100%) rename {services => apis}/imodels/v2/operations/create-imodel/displayName.md (100%) rename {services => apis}/imodels/v2/operations/delete-imodel/description.md (100%) rename {services => apis}/imodels/v2/operations/delete-imodel/displayName.md (100%) rename {services => apis}/imodels/v2/operations/fork-imodel/description.md (100%) rename {services => apis}/imodels/v2/operations/fork-imodel/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-briefcase-checkpoint/description.md (100%) rename {services => apis}/imodels/v2/operations/get-briefcase-checkpoint/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-changeset-checkpoint/description.md (100%) rename {services => apis}/imodels/v2/operations/get-changeset-checkpoint/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-create-imodel-operation-details/description.md (100%) rename {services => apis}/imodels/v2/operations/get-create-imodel-operation-details/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-baseline-file-details/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-baseline-file-details/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-briefcase-details/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-briefcase-details/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-briefcases/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-briefcases/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changeset-details/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changeset-details/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changeset-extended-data-details/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changeset-extended-data-details/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changeset-group-details/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changeset-group-details/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changeset-groups/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changeset-groups/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changesets-extended-data/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changesets-extended-data/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changesets/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-changesets/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-details/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-details/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-locks/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-locks/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-named-version-details/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-named-version-details/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-named-versions/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-named-versions/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-permissions/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-permissions/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-role-permissions/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-role-permissions/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-share/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-share/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-shares/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-shares/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-thumbnail/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-thumbnail/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-user-details/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-user-details/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-user-permissions/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-user-permissions/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-users/description.md (100%) rename {services => apis}/imodels/v2/operations/get-imodel-users/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-itwin-imodels/description.md (100%) rename {services => apis}/imodels/v2/operations/get-itwin-imodels/displayName.md (100%) rename {services => apis}/imodels/v2/operations/get-named-version-checkpoint/description.md (100%) rename {services => apis}/imodels/v2/operations/get-named-version-checkpoint/displayName.md (100%) rename {services => apis}/imodels/v2/operations/release-imodel-briefcase/description.md (100%) rename {services => apis}/imodels/v2/operations/release-imodel-briefcase/displayName.md (100%) rename {services => apis}/imodels/v2/operations/revoke-imodel-share/description.md (100%) rename {services => apis}/imodels/v2/operations/revoke-imodel-share/displayName.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-changeset-group/description.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-changeset-group/displayName.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-changeset/description.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-changeset/displayName.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-locks/description.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-locks/displayName.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-named-version/description.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-named-version/displayName.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-role-permissions/description.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-role-permissions/displayName.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-share/description.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-share/displayName.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-user-permissions/description.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel-user-permissions/displayName.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel/description.md (100%) rename {services => apis}/imodels/v2/operations/update-imodel/displayName.md (100%) rename {services => apis}/imodels/v2/operations/upload-imodel-thumbnail/description.md (100%) rename {services => apis}/imodels/v2/operations/upload-imodel-thumbnail/displayName.md (100%) rename {services => apis}/issues/v1/description.md (100%) rename {services => apis}/issues/v1/operations/add-attachment-to-issue/description.md (100%) rename {services => apis}/issues/v1/operations/add-attachment-to-issue/displayName.md (100%) rename {services => apis}/issues/v1/operations/add-comment-to-issue/description.md (100%) rename {services => apis}/issues/v1/operations/add-comment-to-issue/displayName.md (100%) rename {services => apis}/issues/v1/operations/create-issue/description.md (100%) rename {services => apis}/issues/v1/operations/create-issue/displayName.md (100%) rename {services => apis}/issues/v1/operations/delete-attachment/description.md (100%) rename {services => apis}/issues/v1/operations/delete-attachment/displayName.md (100%) rename {services => apis}/issues/v1/operations/delete-comment/description.md (100%) rename {services => apis}/issues/v1/operations/delete-comment/displayName.md (100%) rename {services => apis}/issues/v1/operations/delete-issue/description.md (100%) rename {services => apis}/issues/v1/operations/delete-issue/displayName.md (100%) rename {services => apis}/issues/v1/operations/download-issue-as-file/description.md (100%) rename {services => apis}/issues/v1/operations/download-issue-as-file/displayName.md (100%) rename {services => apis}/issues/v1/operations/export-issues-to-storage/description.md (100%) rename {services => apis}/issues/v1/operations/export-issues-to-storage/displayName.md (100%) rename {services => apis}/issues/v1/operations/get-attachment-by-id/description.md (100%) rename {services => apis}/issues/v1/operations/get-attachment-by-id/displayName.md (100%) rename {services => apis}/issues/v1/operations/get-form-definition-by-id/description.md (100%) rename {services => apis}/issues/v1/operations/get-form-definition-by-id/displayName.md (100%) rename {services => apis}/issues/v1/operations/get-issue-attachments/description.md (100%) rename {services => apis}/issues/v1/operations/get-issue-attachments/displayName.md (100%) rename {services => apis}/issues/v1/operations/get-issue-audit-trail/description.md (100%) rename {services => apis}/issues/v1/operations/get-issue-audit-trail/displayName.md (100%) rename {services => apis}/issues/v1/operations/get-issue-comments/description.md (100%) rename {services => apis}/issues/v1/operations/get-issue-comments/displayName.md (100%) rename {services => apis}/issues/v1/operations/get-issue-details/description.md (100%) rename {services => apis}/issues/v1/operations/get-issue-details/displayName.md (100%) rename {services => apis}/issues/v1/operations/get-list-group/description.md (100%) rename {services => apis}/issues/v1/operations/get-list-group/displayName.md (100%) rename {services => apis}/issues/v1/operations/get-project-form-definitions/description.md (100%) rename {services => apis}/issues/v1/operations/get-project-form-definitions/displayName.md (100%) rename {services => apis}/issues/v1/operations/get-project-issues/description.md (100%) rename {services => apis}/issues/v1/operations/get-project-issues/displayName.md (100%) rename {services => apis}/issues/v1/operations/get-static-image/description.md (100%) rename {services => apis}/issues/v1/operations/get-static-image/displayName.md (100%) rename {services => apis}/issues/v1/operations/get-workflow/description.md (100%) rename {services => apis}/issues/v1/operations/get-workflow/displayName.md (100%) rename {services => apis}/issues/v1/operations/modify-issue/description.md (100%) rename {services => apis}/issues/v1/operations/modify-issue/displayName.md (100%) rename {services => apis}/issues/v1/operations/upload-attachment-file/description.md (100%) rename {services => apis}/issues/v1/operations/upload-attachment-file/displayName.md (100%) rename {services => apis}/itwin-entities/v1/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/create-entity/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/create-entity/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/create-hierarchy-nodes/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/create-hierarchy-nodes/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/create-hierarchy/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/create-hierarchy/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/create-link/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/create-link/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/delete-entity/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/delete-entity/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/delete-hierarchy-node/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/delete-hierarchy-node/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/delete-hierarchy/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/delete-hierarchy/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/delete-link/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/delete-link/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-entities/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-entities/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-entity/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-entity/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-hierarchies/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-hierarchies/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-hierarchy-nodes/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-hierarchy-nodes/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-hierarchy/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-hierarchy/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-links/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/get-links/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/update-entity/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/update-entity/displayName.md (100%) rename {services => apis}/itwin-entities/v1/operations/update-hierarchy/description.md (100%) rename {services => apis}/itwin-entities/v1/operations/update-hierarchy/displayName.md (100%) rename {services => apis}/itwin-search/v1/description.md (100%) rename {services => apis}/itwin-search/v1/operations/discover/description.md (100%) rename {services => apis}/itwin-search/v1/operations/discover/displayName.md (100%) rename {services => apis}/itwin-search/v1/operations/post-search/description.md (100%) rename {services => apis}/itwin-search/v1/operations/post-search/displayName.md (100%) rename {services => apis}/itwins/v1/description.md (100%) rename {services => apis}/itwins/v1/operations/add-itwin-to-my-favorites/description.md (100%) rename {services => apis}/itwins/v1/operations/add-itwin-to-my-favorites/displayName.md (100%) rename {services => apis}/itwins/v1/operations/add-itwin-to-my-recents/description.md (100%) rename {services => apis}/itwins/v1/operations/add-itwin-to-my-recents/displayName.md (100%) rename {services => apis}/itwins/v1/operations/create-itwin/description.md (100%) rename {services => apis}/itwins/v1/operations/create-itwin/displayName.md (100%) rename {services => apis}/itwins/v1/operations/create-repository/description.md (100%) rename {services => apis}/itwins/v1/operations/create-repository/displayName.md (100%) rename {services => apis}/itwins/v1/operations/delete-itwin-image/description.md (100%) rename {services => apis}/itwins/v1/operations/delete-itwin-image/displayName.md (100%) rename {services => apis}/itwins/v1/operations/delete-itwin/description.md (100%) rename {services => apis}/itwins/v1/operations/delete-itwin/displayName.md (100%) rename {services => apis}/itwins/v1/operations/delete-repository/description.md (100%) rename {services => apis}/itwins/v1/operations/delete-repository/displayName.md (100%) rename {services => apis}/itwins/v1/operations/get-itwin-account/description.md (100%) rename {services => apis}/itwins/v1/operations/get-itwin-account/displayName.md (100%) rename {services => apis}/itwins/v1/operations/get-itwin-image/description.md (100%) rename {services => apis}/itwins/v1/operations/get-itwin-image/displayName.md (100%) rename {services => apis}/itwins/v1/operations/get-itwin/description.md (100%) rename {services => apis}/itwins/v1/operations/get-itwin/displayName.md (100%) rename {services => apis}/itwins/v1/operations/get-my-favorite-itwins/description.md (100%) rename {services => apis}/itwins/v1/operations/get-my-favorite-itwins/displayName.md (100%) rename {services => apis}/itwins/v1/operations/get-my-itwins/description.md (100%) rename {services => apis}/itwins/v1/operations/get-my-itwins/displayName.md (100%) rename {services => apis}/itwins/v1/operations/get-my-primary-account/description.md (100%) rename {services => apis}/itwins/v1/operations/get-my-primary-account/displayName.md (100%) rename {services => apis}/itwins/v1/operations/get-my-recently-used-itwins/description.md (100%) rename {services => apis}/itwins/v1/operations/get-my-recently-used-itwins/displayName.md (100%) rename {services => apis}/itwins/v1/operations/get-repositories-by-itwin-id/description.md (100%) rename {services => apis}/itwins/v1/operations/get-repositories-by-itwin-id/displayName.md (100%) rename {services => apis}/itwins/v1/operations/remove-itwin-from-my-favorites/description.md (100%) rename {services => apis}/itwins/v1/operations/remove-itwin-from-my-favorites/displayName.md (100%) rename {services => apis}/itwins/v1/operations/update-itwin/description.md (100%) rename {services => apis}/itwins/v1/operations/update-itwin/displayName.md (100%) rename {services => apis}/itwins/v1/operations/upload-itwin-image/description.md (100%) rename {services => apis}/itwins/v1/operations/upload-itwin-image/displayName.md (100%) rename {services => apis}/library/v1/description.md (100%) rename {services => apis}/library/v1/operations/create-application/description.md (100%) rename {services => apis}/library/v1/operations/create-application/displayName.md (100%) rename {services => apis}/library/v1/operations/create-catalog-document/description.md (100%) rename {services => apis}/library/v1/operations/create-catalog-document/displayName.md (100%) rename {services => apis}/library/v1/operations/create-catalog-weblink/description.md (100%) rename {services => apis}/library/v1/operations/create-catalog-weblink/displayName.md (100%) rename {services => apis}/library/v1/operations/create-catalog/description.md (100%) rename {services => apis}/library/v1/operations/create-catalog/displayName.md (100%) rename {services => apis}/library/v1/operations/create-category/description.md (100%) rename {services => apis}/library/v1/operations/create-category/displayName.md (100%) rename {services => apis}/library/v1/operations/create-component-document/description.md (100%) rename {services => apis}/library/v1/operations/create-component-document/displayName.md (100%) rename {services => apis}/library/v1/operations/create-component-variation/description.md (100%) rename {services => apis}/library/v1/operations/create-component-variation/displayName.md (100%) rename {services => apis}/library/v1/operations/create-component-weblink/description.md (100%) rename {services => apis}/library/v1/operations/create-component-weblink/displayName.md (100%) rename {services => apis}/library/v1/operations/create-component/description.md (100%) rename {services => apis}/library/v1/operations/create-component/displayName.md (100%) rename {services => apis}/library/v1/operations/create-manufacturer/description.md (100%) rename {services => apis}/library/v1/operations/create-manufacturer/displayName.md (100%) rename {services => apis}/library/v1/operations/delete-application/description.md (100%) rename {services => apis}/library/v1/operations/delete-application/displayName.md (100%) rename {services => apis}/library/v1/operations/delete-catalog-document/description.md (100%) rename {services => apis}/library/v1/operations/delete-catalog-document/displayName.md (100%) rename {services => apis}/library/v1/operations/delete-catalog-weblink/description.md (100%) rename {services => apis}/library/v1/operations/delete-catalog-weblink/displayName.md (100%) rename {services => apis}/library/v1/operations/delete-catalog/description.md (100%) rename {services => apis}/library/v1/operations/delete-catalog/displayName.md (100%) rename {services => apis}/library/v1/operations/delete-category/description.md (100%) rename {services => apis}/library/v1/operations/delete-category/displayName.md (100%) rename {services => apis}/library/v1/operations/delete-component-document/description.md (100%) rename {services => apis}/library/v1/operations/delete-component-document/displayName.md (100%) rename {services => apis}/library/v1/operations/delete-component-variation/description.md (100%) rename {services => apis}/library/v1/operations/delete-component-variation/displayName.md (100%) rename {services => apis}/library/v1/operations/delete-component-weblink/description.md (100%) rename {services => apis}/library/v1/operations/delete-component-weblink/displayName.md (100%) rename {services => apis}/library/v1/operations/delete-component/description.md (100%) rename {services => apis}/library/v1/operations/delete-component/displayName.md (100%) rename {services => apis}/library/v1/operations/delete-manufacturer/description.md (100%) rename {services => apis}/library/v1/operations/delete-manufacturer/displayName.md (100%) rename {services => apis}/library/v1/operations/download-analytics/description.md (100%) rename {services => apis}/library/v1/operations/download-analytics/displayName.md (100%) rename {services => apis}/library/v1/operations/get-application/description.md (100%) rename {services => apis}/library/v1/operations/get-application/displayName.md (100%) rename {services => apis}/library/v1/operations/get-applications/description.md (100%) rename {services => apis}/library/v1/operations/get-applications/displayName.md (100%) rename {services => apis}/library/v1/operations/get-brand-component-documents/description.md (100%) rename {services => apis}/library/v1/operations/get-brand-component-documents/displayName.md (100%) rename {services => apis}/library/v1/operations/get-brand-component-variations/description.md (100%) rename {services => apis}/library/v1/operations/get-brand-component-variations/displayName.md (100%) rename {services => apis}/library/v1/operations/get-brand-component-weblinks/description.md (100%) rename {services => apis}/library/v1/operations/get-brand-component-weblinks/displayName.md (100%) rename {services => apis}/library/v1/operations/get-brand-components/description.md (100%) rename {services => apis}/library/v1/operations/get-brand-components/displayName.md (100%) rename {services => apis}/library/v1/operations/get-brand/description.md (100%) rename {services => apis}/library/v1/operations/get-brand/displayName.md (100%) rename {services => apis}/library/v1/operations/get-brands/description.md (100%) rename {services => apis}/library/v1/operations/get-brands/displayName.md (100%) rename {services => apis}/library/v1/operations/get-catalog-document/description.md (100%) rename {services => apis}/library/v1/operations/get-catalog-document/displayName.md (100%) rename {services => apis}/library/v1/operations/get-catalog-documents/description.md (100%) rename {services => apis}/library/v1/operations/get-catalog-documents/displayName.md (100%) rename {services => apis}/library/v1/operations/get-catalog-weblink/description.md (100%) rename {services => apis}/library/v1/operations/get-catalog-weblink/displayName.md (100%) rename {services => apis}/library/v1/operations/get-catalog-weblinks/description.md (100%) rename {services => apis}/library/v1/operations/get-catalog-weblinks/displayName.md (100%) rename {services => apis}/library/v1/operations/get-catalog/description.md (100%) rename {services => apis}/library/v1/operations/get-catalog/displayName.md (100%) rename {services => apis}/library/v1/operations/get-catalogs/description.md (100%) rename {services => apis}/library/v1/operations/get-catalogs/displayName.md (100%) rename {services => apis}/library/v1/operations/get-categories/description.md (100%) rename {services => apis}/library/v1/operations/get-categories/displayName.md (100%) rename {services => apis}/library/v1/operations/get-category/description.md (100%) rename {services => apis}/library/v1/operations/get-category/displayName.md (100%) rename {services => apis}/library/v1/operations/get-component-document/description.md (100%) rename {services => apis}/library/v1/operations/get-component-document/displayName.md (100%) rename {services => apis}/library/v1/operations/get-component-documents/description.md (100%) rename {services => apis}/library/v1/operations/get-component-documents/displayName.md (100%) rename {services => apis}/library/v1/operations/get-component-variation/description.md (100%) rename {services => apis}/library/v1/operations/get-component-variation/displayName.md (100%) rename {services => apis}/library/v1/operations/get-component-variations/description.md (100%) rename {services => apis}/library/v1/operations/get-component-variations/displayName.md (100%) rename {services => apis}/library/v1/operations/get-component-weblink/description.md (100%) rename {services => apis}/library/v1/operations/get-component-weblink/displayName.md (100%) rename {services => apis}/library/v1/operations/get-component-weblinks/description.md (100%) rename {services => apis}/library/v1/operations/get-component-weblinks/displayName.md (100%) rename {services => apis}/library/v1/operations/get-component/description.md (100%) rename {services => apis}/library/v1/operations/get-component/displayName.md (100%) rename {services => apis}/library/v1/operations/get-components/description.md (100%) rename {services => apis}/library/v1/operations/get-components/displayName.md (100%) rename {services => apis}/library/v1/operations/get-job/description.md (100%) rename {services => apis}/library/v1/operations/get-job/displayName.md (100%) rename {services => apis}/library/v1/operations/get-manufacturer/description.md (100%) rename {services => apis}/library/v1/operations/get-manufacturer/displayName.md (100%) rename {services => apis}/library/v1/operations/get-manufacturers/description.md (100%) rename {services => apis}/library/v1/operations/get-manufacturers/displayName.md (100%) rename {services => apis}/library/v1/operations/update-application/description.md (100%) rename {services => apis}/library/v1/operations/update-application/displayName.md (100%) rename {services => apis}/library/v1/operations/update-catalog-document/description.md (100%) rename {services => apis}/library/v1/operations/update-catalog-document/displayName.md (100%) rename {services => apis}/library/v1/operations/update-catalog-weblink/description.md (100%) rename {services => apis}/library/v1/operations/update-catalog-weblink/displayName.md (100%) rename {services => apis}/library/v1/operations/update-catalog/description.md (100%) rename {services => apis}/library/v1/operations/update-catalog/displayName.md (100%) rename {services => apis}/library/v1/operations/update-category/description.md (100%) rename {services => apis}/library/v1/operations/update-category/displayName.md (100%) rename {services => apis}/library/v1/operations/update-component-document/description.md (100%) rename {services => apis}/library/v1/operations/update-component-document/displayName.md (100%) rename {services => apis}/library/v1/operations/update-component-variation/description.md (100%) rename {services => apis}/library/v1/operations/update-component-variation/displayName.md (100%) rename {services => apis}/library/v1/operations/update-component-weblink/description.md (100%) rename {services => apis}/library/v1/operations/update-component-weblink/displayName.md (100%) rename {services => apis}/library/v1/operations/update-component/description.md (100%) rename {services => apis}/library/v1/operations/update-component/displayName.md (100%) rename {services => apis}/library/v1/operations/update-manufacturer/description.md (100%) rename {services => apis}/library/v1/operations/update-manufacturer/displayName.md (100%) rename {services => apis}/library/v1/operations/upload-component/description.md (100%) rename {services => apis}/library/v1/operations/upload-component/displayName.md (100%) rename {services => apis}/mesh-export/v1/description.md (100%) rename {services => apis}/mesh-export/v1/operations/delete-export/description.md (100%) rename {services => apis}/mesh-export/v1/operations/delete-export/displayName.md (100%) rename {services => apis}/mesh-export/v1/operations/get-export/description.md (100%) rename {services => apis}/mesh-export/v1/operations/get-export/displayName.md (100%) rename {services => apis}/mesh-export/v1/operations/get-exports/description.md (100%) rename {services => apis}/mesh-export/v1/operations/get-exports/displayName.md (100%) rename {services => apis}/mesh-export/v1/operations/start-export/description.md (100%) rename {services => apis}/mesh-export/v1/operations/start-export/displayName.md (100%) rename {services => apis}/named-groups/v1/operations/create-group/description.md (100%) rename {services => apis}/named-groups/v1/operations/create-group/displayName.md (100%) rename {services => apis}/named-groups/v1/operations/delete-group/description.md (100%) rename {services => apis}/named-groups/v1/operations/delete-group/displayName.md (100%) rename {services => apis}/named-groups/v1/operations/get-group/description.md (100%) rename {services => apis}/named-groups/v1/operations/get-group/displayName.md (100%) rename {services => apis}/named-groups/v1/operations/get-itwin-groups/description.md (100%) rename {services => apis}/named-groups/v1/operations/get-itwin-groups/displayName.md (100%) rename {services => apis}/named-groups/v1/operations/update-group/description.md (100%) rename {services => apis}/named-groups/v1/operations/update-group/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/create-inference-run/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/create-inference-run/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/create-inference/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/create-inference/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/delete-inference-input/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/delete-inference-input/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/delete-inference-run/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/delete-inference-run/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/delete-inference/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/delete-inference/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference-input-content/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference-input-content/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference-inputs/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference-inputs/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference-run-result-content/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference-run-result-content/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference-run-results/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference-run-results/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference-run/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference-run/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-inference/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-itwin-inferences/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/get-itwin-inferences/displayName.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/upload-inference-input-content/description.md (100%) rename {services => apis}/pnid-to-itwin/v2/operations/upload-inference-input-content/displayName.md (100%) rename {services => apis}/projects/v1/description.md (100%) rename {services => apis}/projects/v1/operations/add-project-team-member/description.md (100%) rename {services => apis}/projects/v1/operations/add-project-team-member/displayName.md (100%) rename {services => apis}/projects/v1/operations/add-project-to-my-favorites/description.md (100%) rename {services => apis}/projects/v1/operations/add-project-to-my-favorites/displayName.md (100%) rename {services => apis}/projects/v1/operations/add-project-to-my-recents/description.md (100%) rename {services => apis}/projects/v1/operations/add-project-to-my-recents/displayName.md (100%) rename {services => apis}/projects/v1/operations/create-project-role/description.md (100%) rename {services => apis}/projects/v1/operations/create-project-role/displayName.md (100%) rename {services => apis}/projects/v1/operations/create-project/description.md (100%) rename {services => apis}/projects/v1/operations/create-project/displayName.md (100%) rename {services => apis}/projects/v1/operations/delete-project-role/description.md (100%) rename {services => apis}/projects/v1/operations/delete-project-role/displayName.md (100%) rename {services => apis}/projects/v1/operations/delete-project/description.md (100%) rename {services => apis}/projects/v1/operations/delete-project/displayName.md (100%) rename {services => apis}/projects/v1/operations/get-my-favorite-projects/description.md (100%) rename {services => apis}/projects/v1/operations/get-my-favorite-projects/displayName.md (100%) rename {services => apis}/projects/v1/operations/get-my-recently-used-projects/description.md (100%) rename {services => apis}/projects/v1/operations/get-my-recently-used-projects/displayName.md (100%) rename {services => apis}/projects/v1/operations/get-project-roles/description.md (100%) rename {services => apis}/projects/v1/operations/get-project-roles/displayName.md (100%) rename {services => apis}/projects/v1/operations/get-project-team-member-details/description.md (100%) rename {services => apis}/projects/v1/operations/get-project-team-member-details/displayName.md (100%) rename {services => apis}/projects/v1/operations/get-project-team-members/description.md (100%) rename {services => apis}/projects/v1/operations/get-project-team-members/displayName.md (100%) rename {services => apis}/projects/v1/operations/get-project/description.md (100%) rename {services => apis}/projects/v1/operations/get-project/displayName.md (100%) rename {services => apis}/projects/v1/operations/get-user-permissions/description.md (100%) rename {services => apis}/projects/v1/operations/get-user-permissions/displayName.md (100%) rename {services => apis}/projects/v1/operations/my-projects/description.md (100%) rename {services => apis}/projects/v1/operations/my-projects/displayName.md (100%) rename {services => apis}/projects/v1/operations/remove-project-from-my-favorites/description.md (100%) rename {services => apis}/projects/v1/operations/remove-project-from-my-favorites/displayName.md (100%) rename {services => apis}/projects/v1/operations/remove-project-team-member/description.md (100%) rename {services => apis}/projects/v1/operations/remove-project-team-member/displayName.md (100%) rename {services => apis}/projects/v1/operations/update-project-role/description.md (100%) rename {services => apis}/projects/v1/operations/update-project-role/displayName.md (100%) rename {services => apis}/projects/v1/operations/update-project-team-member-roles/description.md (100%) rename {services => apis}/projects/v1/operations/update-project-team-member-roles/displayName.md (100%) rename {services => apis}/projects/v1/operations/update-project/description.md (100%) rename {services => apis}/projects/v1/operations/update-project/displayName.md (100%) rename {services => apis}/projectwise365-insights/v1/description.md (100%) rename {services => apis}/projectwise365-insights/v1/operations/project-metadata/description.md (100%) rename {services => apis}/projectwise365-insights/v1/operations/project-metadata/displayName.md (100%) rename {services => apis}/projectwise365-insights/v1/operations/project-odata/description.md (100%) rename {services => apis}/projectwise365-insights/v1/operations/project-odata/displayName.md (100%) rename {services => apis}/projectwise365-insights/v1/operations/project-schema/description.md (100%) rename {services => apis}/projectwise365-insights/v1/operations/project-schema/displayName.md (100%) rename {services => apis}/reality-data/v1/description.md (100%) rename {services => apis}/reality-data/v1/operations/associate-to-project/description.md (100%) rename {services => apis}/reality-data/v1/operations/associate-to-project/displayName.md (100%) rename {services => apis}/reality-data/v1/operations/create-reality-data/description.md (100%) rename {services => apis}/reality-data/v1/operations/create-reality-data/displayName.md (100%) rename {services => apis}/reality-data/v1/operations/delete-reality-data/description.md (100%) rename {services => apis}/reality-data/v1/operations/delete-reality-data/displayName.md (100%) rename {services => apis}/reality-data/v1/operations/dissociate-from-project/description.md (100%) rename {services => apis}/reality-data/v1/operations/dissociate-from-project/displayName.md (100%) rename {services => apis}/reality-data/v1/operations/get-all-reality-data/description.md (100%) rename {services => apis}/reality-data/v1/operations/get-all-reality-data/displayName.md (100%) rename {services => apis}/reality-data/v1/operations/get-reality-data-container/description.md (100%) rename {services => apis}/reality-data/v1/operations/get-reality-data-container/displayName.md (100%) rename {services => apis}/reality-data/v1/operations/get-reality-data-details/description.md (100%) rename {services => apis}/reality-data/v1/operations/get-reality-data-details/displayName.md (100%) rename {services => apis}/reality-data/v1/operations/get-reality-data-projects/description.md (100%) rename {services => apis}/reality-data/v1/operations/get-reality-data-projects/displayName.md (100%) rename {services => apis}/reality-data/v1/operations/update-reality-data/description.md (100%) rename {services => apis}/reality-data/v1/operations/update-reality-data/displayName.md (100%) rename {services => apis}/reality-management/v1/description.md (100%) rename {services => apis}/reality-management/v1/operations/associate-to-iTwin/description.md (100%) rename {services => apis}/reality-management/v1/operations/associate-to-iTwin/displayName.md (100%) rename {services => apis}/reality-management/v1/operations/create-reality-data/description.md (100%) rename {services => apis}/reality-management/v1/operations/create-reality-data/displayName.md (100%) rename {services => apis}/reality-management/v1/operations/delete-reality-data/description.md (100%) rename {services => apis}/reality-management/v1/operations/delete-reality-data/displayName.md (100%) rename {services => apis}/reality-management/v1/operations/dissociate-from-iTwin/description.md (100%) rename {services => apis}/reality-management/v1/operations/dissociate-from-iTwin/displayName.md (100%) rename {services => apis}/reality-management/v1/operations/get-all-reality-data/description.md (100%) rename {services => apis}/reality-management/v1/operations/get-all-reality-data/displayName.md (100%) rename {services => apis}/reality-management/v1/operations/get-read-access-to-reality-data-container/description.md (100%) rename {services => apis}/reality-management/v1/operations/get-read-access-to-reality-data-container/displayName.md (100%) rename {services => apis}/reality-management/v1/operations/get-reality-data-details/description.md (100%) rename {services => apis}/reality-management/v1/operations/get-reality-data-details/displayName.md (100%) rename {services => apis}/reality-management/v1/operations/get-reality-data-iTwins/description.md (100%) rename {services => apis}/reality-management/v1/operations/get-reality-data-iTwins/displayName.md (100%) rename {services => apis}/reality-management/v1/operations/get-write-access-to-reality-data-container/description.md (100%) rename {services => apis}/reality-management/v1/operations/get-write-access-to-reality-data-container/displayName.md (100%) rename {services => apis}/reality-management/v1/operations/update-reality-data/description.md (100%) rename {services => apis}/reality-management/v1/operations/update-reality-data/displayName.md (100%) rename {services => apis}/realityconversion/v1/description.md (100%) rename {services => apis}/realityconversion/v1/operations/jobs-create/description.md (100%) rename {services => apis}/realityconversion/v1/operations/jobs-create/displayName.md (100%) rename {services => apis}/realityconversion/v1/operations/jobs-delete/description.md (100%) rename {services => apis}/realityconversion/v1/operations/jobs-delete/displayName.md (100%) rename {services => apis}/realityconversion/v1/operations/jobs-get/description.md (100%) rename {services => apis}/realityconversion/v1/operations/jobs-get/displayName.md (100%) rename {services => apis}/realityconversion/v1/operations/jobs-patch/description.md (100%) rename {services => apis}/realityconversion/v1/operations/jobs-patch/displayName.md (100%) rename {services => apis}/realityconversion/v1/operations/jobs-progress/description.md (100%) rename {services => apis}/realityconversion/v1/operations/jobs-progress/displayName.md (100%) rename {services => apis}/realitydataanalysis/v1/description.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-create/description.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-create/displayName.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-delete/description.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-delete/displayName.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-get-all/description.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-get-all/displayName.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-get/description.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-get/displayName.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-patch/description.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-patch/displayName.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-progress/description.md (100%) rename {services => apis}/realitydataanalysis/v1/operations/jobs-progress/displayName.md (100%) rename {services => apis}/reporting/v2/description.md (100%) rename {services => apis}/reporting/v2/operations/create-apikey/description.md (100%) rename {services => apis}/reporting/v2/operations/create-apikey/displayName.md (100%) rename {services => apis}/reporting/v2/operations/create-report-mapping/description.md (100%) rename {services => apis}/reporting/v2/operations/create-report-mapping/displayName.md (100%) rename {services => apis}/reporting/v2/operations/create-report/description.md (100%) rename {services => apis}/reporting/v2/operations/create-report/displayName.md (100%) rename {services => apis}/reporting/v2/operations/delete-report-mapping/description.md (100%) rename {services => apis}/reporting/v2/operations/delete-report-mapping/displayName.md (100%) rename {services => apis}/reporting/v2/operations/delete-report/description.md (100%) rename {services => apis}/reporting/v2/operations/delete-report/displayName.md (100%) rename {services => apis}/reporting/v2/operations/get-apikey/description.md (100%) rename {services => apis}/reporting/v2/operations/get-apikey/displayName.md (100%) rename {services => apis}/reporting/v2/operations/get-apikeys/description.md (100%) rename {services => apis}/reporting/v2/operations/get-apikeys/displayName.md (100%) rename {services => apis}/reporting/v2/operations/get-itwin-reports/description.md (100%) rename {services => apis}/reporting/v2/operations/get-itwin-reports/displayName.md (100%) rename {services => apis}/reporting/v2/operations/get-report-mappings/description.md (100%) rename {services => apis}/reporting/v2/operations/get-report-mappings/displayName.md (100%) rename {services => apis}/reporting/v2/operations/get-report/description.md (100%) rename {services => apis}/reporting/v2/operations/get-report/displayName.md (100%) rename {services => apis}/reporting/v2/operations/odata-entity/description.md (100%) rename {services => apis}/reporting/v2/operations/odata-entity/displayName.md (100%) rename {services => apis}/reporting/v2/operations/odata-metadata/description.md (100%) rename {services => apis}/reporting/v2/operations/odata-metadata/displayName.md (100%) rename {services => apis}/reporting/v2/operations/odata/description.md (100%) rename {services => apis}/reporting/v2/operations/odata/displayName.md (100%) rename {services => apis}/reporting/v2/operations/revoke-apikey/description.md (100%) rename {services => apis}/reporting/v2/operations/revoke-apikey/displayName.md (100%) rename {services => apis}/reporting/v2/operations/update-apikey/description.md (100%) rename {services => apis}/reporting/v2/operations/update-apikey/displayName.md (100%) rename {services => apis}/reporting/v2/operations/update-report/description.md (100%) rename {services => apis}/reporting/v2/operations/update-report/displayName.md (100%) rename {services => apis}/savedviews/v1/description.md (100%) rename {services => apis}/savedviews/v1/operations/add-image/description.md (100%) rename {services => apis}/savedviews/v1/operations/add-image/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/create-extension/description.md (100%) rename {services => apis}/savedviews/v1/operations/create-extension/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/create-group/description.md (100%) rename {services => apis}/savedviews/v1/operations/create-group/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/create-savedview/description.md (100%) rename {services => apis}/savedviews/v1/operations/create-savedview/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/create-tag/description.md (100%) rename {services => apis}/savedviews/v1/operations/create-tag/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/delete-extension/description.md (100%) rename {services => apis}/savedviews/v1/operations/delete-extension/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/delete-group/description.md (100%) rename {services => apis}/savedviews/v1/operations/delete-group/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/delete-savedview/description.md (100%) rename {services => apis}/savedviews/v1/operations/delete-savedview/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/delete-tag/description.md (100%) rename {services => apis}/savedviews/v1/operations/delete-tag/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/get-all-extensions/description.md (100%) rename {services => apis}/savedviews/v1/operations/get-all-extensions/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/get-all-groups/description.md (100%) rename {services => apis}/savedviews/v1/operations/get-all-groups/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/get-all-savedviews/description.md (100%) rename {services => apis}/savedviews/v1/operations/get-all-savedviews/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/get-all-tags/description.md (100%) rename {services => apis}/savedviews/v1/operations/get-all-tags/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/get-extension/description.md (100%) rename {services => apis}/savedviews/v1/operations/get-extension/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/get-group/description.md (100%) rename {services => apis}/savedviews/v1/operations/get-group/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/get-image/description.md (100%) rename {services => apis}/savedviews/v1/operations/get-image/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/get-savedview/description.md (100%) rename {services => apis}/savedviews/v1/operations/get-savedview/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/get-tag/description.md (100%) rename {services => apis}/savedviews/v1/operations/get-tag/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/update-group/description.md (100%) rename {services => apis}/savedviews/v1/operations/update-group/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/update-savedview/description.md (100%) rename {services => apis}/savedviews/v1/operations/update-savedview/displayName.md (100%) rename {services => apis}/savedviews/v1/operations/update-tag/description.md (100%) rename {services => apis}/savedviews/v1/operations/update-tag/displayName.md (100%) rename {services => apis}/sensor-data/v1/description.md (100%) rename {services => apis}/sensor-data/v1/operations/get-nodes/description.md (100%) rename {services => apis}/sensor-data/v1/operations/get-nodes/displayName.md (100%) rename {services => apis}/sensor-data/v1/operations/process-integration/description.md (100%) rename {services => apis}/sensor-data/v1/operations/process-integration/displayName.md (100%) rename {services => apis}/sensor-data/v1/operations/query-raw-data/description.md (100%) rename {services => apis}/sensor-data/v1/operations/query-raw-data/displayName.md (100%) rename {services => apis}/sensor-data/v1/operations/remove-data/description.md (100%) rename {services => apis}/sensor-data/v1/operations/remove-data/displayName.md (100%) rename {services => apis}/sensor-data/v1/operations/upload-data/description.md (100%) rename {services => apis}/sensor-data/v1/operations/upload-data/displayName.md (100%) rename {services => apis}/storage-container/v1/description.md (100%) rename {services => apis}/storage-container/v1/operations/clone-storage-container/description.md (100%) rename {services => apis}/storage-container/v1/operations/clone-storage-container/displayName.md (100%) rename {services => apis}/storage-container/v1/operations/create-storage-container/description.md (100%) rename {services => apis}/storage-container/v1/operations/create-storage-container/displayName.md (100%) rename {services => apis}/storage-container/v1/operations/delete-storage-container/description.md (100%) rename {services => apis}/storage-container/v1/operations/delete-storage-container/displayName.md (100%) rename {services => apis}/storage-container/v1/operations/get-single-storage-container/description.md (100%) rename {services => apis}/storage-container/v1/operations/get-single-storage-container/displayName.md (100%) rename {services => apis}/storage-container/v1/operations/get-storage-containers/description.md (100%) rename {services => apis}/storage-container/v1/operations/get-storage-containers/displayName.md (100%) rename {services => apis}/storage-container/v1/operations/update-container-metadata-json/description.md (100%) rename {services => apis}/storage-container/v1/operations/update-container-metadata-json/displayName.md (100%) rename {services => apis}/storage/v1/description.md (100%) rename {services => apis}/storage/v1/operations/complete-file-creation/description.md (100%) rename {services => apis}/storage/v1/operations/complete-file-creation/displayName.md (100%) rename {services => apis}/storage/v1/operations/create-file/description.md (100%) rename {services => apis}/storage/v1/operations/create-file/displayName.md (100%) rename {services => apis}/storage/v1/operations/create-folder/description.md (100%) rename {services => apis}/storage/v1/operations/create-folder/displayName.md (100%) rename {services => apis}/storage/v1/operations/delete-file-from-recycle-bin/description.md (100%) rename {services => apis}/storage/v1/operations/delete-file-from-recycle-bin/displayName.md (100%) rename {services => apis}/storage/v1/operations/delete-file/description.md (100%) rename {services => apis}/storage/v1/operations/delete-file/displayName.md (100%) rename {services => apis}/storage/v1/operations/delete-folder-from-recycle-bin/description.md (100%) rename {services => apis}/storage/v1/operations/delete-folder-from-recycle-bin/displayName.md (100%) rename {services => apis}/storage/v1/operations/delete-folder/description.md (100%) rename {services => apis}/storage/v1/operations/delete-folder/displayName.md (100%) rename {services => apis}/storage/v1/operations/download-file/description.md (100%) rename {services => apis}/storage/v1/operations/download-file/displayName.md (100%) rename {services => apis}/storage/v1/operations/get-file/description.md (100%) rename {services => apis}/storage/v1/operations/get-file/displayName.md (100%) rename {services => apis}/storage/v1/operations/get-files-in-folder/description.md (100%) rename {services => apis}/storage/v1/operations/get-files-in-folder/displayName.md (100%) rename {services => apis}/storage/v1/operations/get-folder/description.md (100%) rename {services => apis}/storage/v1/operations/get-folder/displayName.md (100%) rename {services => apis}/storage/v1/operations/get-folders-and-files-in-folder/description.md (100%) rename {services => apis}/storage/v1/operations/get-folders-and-files-in-folder/displayName.md (100%) rename {services => apis}/storage/v1/operations/get-folders-and-files-in-recycle-bin/description.md (100%) rename {services => apis}/storage/v1/operations/get-folders-and-files-in-recycle-bin/displayName.md (100%) rename {services => apis}/storage/v1/operations/get-folders-in-folder/description.md (100%) rename {services => apis}/storage/v1/operations/get-folders-in-folder/displayName.md (100%) rename {services => apis}/storage/v1/operations/get-top-level-folders-and-files-by-project/description.md (100%) rename {services => apis}/storage/v1/operations/get-top-level-folders-and-files-by-project/displayName.md (100%) rename {services => apis}/storage/v1/operations/lock-files-in-folder/description.md (100%) rename {services => apis}/storage/v1/operations/lock-files-in-folder/displayName.md (100%) rename {services => apis}/storage/v1/operations/move-file-legacy/description.md (100%) rename {services => apis}/storage/v1/operations/move-file-legacy/displayName.md (100%) rename {services => apis}/storage/v1/operations/move-file/description.md (100%) rename {services => apis}/storage/v1/operations/move-file/displayName.md (100%) rename {services => apis}/storage/v1/operations/move-folder/description.md (100%) rename {services => apis}/storage/v1/operations/move-folder/displayName.md (100%) rename {services => apis}/storage/v1/operations/restore-file/description.md (100%) rename {services => apis}/storage/v1/operations/restore-file/displayName.md (100%) rename {services => apis}/storage/v1/operations/restore-folder/description.md (100%) rename {services => apis}/storage/v1/operations/restore-folder/displayName.md (100%) rename {services => apis}/storage/v1/operations/search-for-folders-and-files-in-folder/description.md (100%) rename {services => apis}/storage/v1/operations/search-for-folders-and-files-in-folder/displayName.md (100%) rename {services => apis}/storage/v1/operations/unlock-files-in-folder/description.md (100%) rename {services => apis}/storage/v1/operations/unlock-files-in-folder/displayName.md (100%) rename {services => apis}/storage/v1/operations/update-file-content/description.md (100%) rename {services => apis}/storage/v1/operations/update-file-content/displayName.md (100%) rename {services => apis}/storage/v1/operations/update-file/description.md (100%) rename {services => apis}/storage/v1/operations/update-file/displayName.md (100%) rename {services => apis}/storage/v1/operations/update-folder/description.md (100%) rename {services => apis}/storage/v1/operations/update-folder/displayName.md (100%) rename {services => apis}/synchronization/v1/description.md (100%) rename {services => apis}/synchronization/v1/operations/add-manifest-connection-sourcefile/description.md (100%) rename {services => apis}/synchronization/v1/operations/add-manifest-connection-sourcefile/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/add-storage-connection-sourcefile/description.md (100%) rename {services => apis}/synchronization/v1/operations/add-storage-connection-sourcefile/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/create-connection-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/create-connection-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/create-imodel-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/create-imodel-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/create-itwin-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/create-itwin-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/create-manifest-connection-run/description.md (100%) rename {services => apis}/synchronization/v1/operations/create-manifest-connection-run/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/create-manifest-connection/description.md (100%) rename {services => apis}/synchronization/v1/operations/create-manifest-connection/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/create-storage-connection/description.md (100%) rename {services => apis}/synchronization/v1/operations/create-storage-connection/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/delete-connection-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/delete-connection-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/delete-imodel-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/delete-imodel-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/delete-itwin-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/delete-itwin-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/delete-manifest-connection/description.md (100%) rename {services => apis}/synchronization/v1/operations/delete-manifest-connection/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/delete-storage-connection/description.md (100%) rename {services => apis}/synchronization/v1/operations/delete-storage-connection/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-authorization-information/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-authorization-information/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-connection-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-connection-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-connections/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-connections/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-imodel-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-imodel-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-itwin-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-itwin-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connection-run/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connection-run/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connection-runs/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connection-runs/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connection-sourcefile/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connection-sourcefile/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connection-sourcefiles/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connection-sourcefiles/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connection/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connection/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connections/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-manifest-connections/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connection-run/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connection-run/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connection-runs/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connection-runs/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connection-sourcefile/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connection-sourcefile/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connection-sourcefiles/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connection-sourcefiles/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connection/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connection/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connections/description.md (100%) rename {services => apis}/synchronization/v1/operations/get-storage-connections/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/patch-connection-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/patch-connection-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/patch-imodel-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/patch-imodel-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/patch-itwin-configuration/description.md (100%) rename {services => apis}/synchronization/v1/operations/patch-itwin-configuration/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/remove-manifest-connection-sourcefile/description.md (100%) rename {services => apis}/synchronization/v1/operations/remove-manifest-connection-sourcefile/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/remove-storage-connection-sourcefile/description.md (100%) rename {services => apis}/synchronization/v1/operations/remove-storage-connection-sourcefile/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/run-storage-connection/description.md (100%) rename {services => apis}/synchronization/v1/operations/run-storage-connection/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/update-manifest-connection-sourcefile/description.md (100%) rename {services => apis}/synchronization/v1/operations/update-manifest-connection-sourcefile/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/update-manifest-connection/description.md (100%) rename {services => apis}/synchronization/v1/operations/update-manifest-connection/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/update-storage-connection-sourcefile/description.md (100%) rename {services => apis}/synchronization/v1/operations/update-storage-connection-sourcefile/displayName.md (100%) rename {services => apis}/synchronization/v1/operations/update-storage-connection/description.md (100%) rename {services => apis}/synchronization/v1/operations/update-storage-connection/displayName.md (100%) rename {services => apis}/transformations/v1/description.md (100%) rename {services => apis}/transformations/v1/operations/alignimodeldata/description.md (100%) rename {services => apis}/transformations/v1/operations/alignimodeldata/displayName.md (100%) rename {services => apis}/transformations/v1/operations/combineimodels/description.md (100%) rename {services => apis}/transformations/v1/operations/combineimodels/displayName.md (100%) rename {services => apis}/transformations/v1/operations/combinephysicalmodels/description.md (100%) rename {services => apis}/transformations/v1/operations/combinephysicalmodels/displayName.md (100%) rename {services => apis}/transformations/v1/operations/combinephysicalmodelsv2/description.md (100%) rename {services => apis}/transformations/v1/operations/combinephysicalmodelsv2/displayName.md (100%) rename {services => apis}/transformations/v1/operations/create-transformation/description.md (100%) rename {services => apis}/transformations/v1/operations/create-transformation/displayName.md (100%) rename {services => apis}/transformations/v1/operations/createfork/description.md (100%) rename {services => apis}/transformations/v1/operations/createfork/displayName.md (100%) rename {services => apis}/transformations/v1/operations/delete-configuration/description.md (100%) rename {services => apis}/transformations/v1/operations/delete-configuration/displayName.md (100%) rename {services => apis}/transformations/v1/operations/delete-transformation/description.md (100%) rename {services => apis}/transformations/v1/operations/delete-transformation/displayName.md (100%) rename {services => apis}/transformations/v1/operations/filterbyviewdefinition/description.md (100%) rename {services => apis}/transformations/v1/operations/filterbyviewdefinition/displayName.md (100%) rename {services => apis}/transformations/v1/operations/filterimodel/description.md (100%) rename {services => apis}/transformations/v1/operations/filterimodel/displayName.md (100%) rename {services => apis}/transformations/v1/operations/filtersubcategories/description.md (100%) rename {services => apis}/transformations/v1/operations/filtersubcategories/displayName.md (100%) rename {services => apis}/transformations/v1/operations/get-all-configurations/description.md (100%) rename {services => apis}/transformations/v1/operations/get-all-configurations/displayName.md (100%) rename {services => apis}/transformations/v1/operations/get-all-transformations/description.md (100%) rename {services => apis}/transformations/v1/operations/get-all-transformations/displayName.md (100%) rename {services => apis}/transformations/v1/operations/get-configuration/description.md (100%) rename {services => apis}/transformations/v1/operations/get-configuration/displayName.md (100%) rename {services => apis}/transformations/v1/operations/get-transformation/description.md (100%) rename {services => apis}/transformations/v1/operations/get-transformation/displayName.md (100%) rename {services => apis}/transformations/v1/operations/groupandmap/description.md (100%) rename {services => apis}/transformations/v1/operations/groupandmap/displayName.md (100%) rename {services => apis}/transformations/v1/operations/importimodel/description.md (100%) rename {services => apis}/transformations/v1/operations/importimodel/displayName.md (100%) rename {services => apis}/transformations/v1/operations/mergefork/description.md (100%) rename {services => apis}/transformations/v1/operations/mergefork/displayName.md (100%) rename {services => apis}/transformations/v1/operations/mergeimodel/description.md (100%) rename {services => apis}/transformations/v1/operations/mergeimodel/displayName.md (100%) rename {services => apis}/transformations/v1/operations/populatefederationguids/description.md (100%) rename {services => apis}/transformations/v1/operations/populatefederationguids/displayName.md (100%) rename {services => apis}/users/v1/description.md (100%) rename {services => apis}/users/v1/operations/get-user/description.md (100%) rename {services => apis}/users/v1/operations/get-user/displayName.md (100%) rename {services => apis}/users/v1/operations/get-users-by-id-list/description.md (100%) rename {services => apis}/users/v1/operations/get-users-by-id-list/displayName.md (100%) rename {services => apis}/users/v1/operations/get-users/description.md (100%) rename {services => apis}/users/v1/operations/get-users/displayName.md (100%) rename {services => apis}/users/v1/operations/me/description.md (100%) rename {services => apis}/users/v1/operations/me/displayName.md (100%) rename {services/access-control => apis}/v2/description.md (100%) rename {services/access-control => apis}/v2/operations/add-itwin-group-members/description.md (100%) create mode 100644 apis/v2/operations/add-itwin-group-members/displayName.md rename {services/access-control => apis}/v2/operations/add-itwin-owner-member/description.md (100%) create mode 100644 apis/v2/operations/add-itwin-owner-member/displayName.md rename {services/access-control => apis}/v2/operations/add-itwin-user-members/description.md (100%) create mode 100644 apis/v2/operations/add-itwin-user-members/displayName.md rename {services/access-control => apis}/v2/operations/create-iTwin-role/description.md (100%) create mode 100644 apis/v2/operations/create-iTwin-role/displayName.md rename {services/access-control => apis}/v2/operations/create-itwin-group/description.md (100%) create mode 100644 apis/v2/operations/create-itwin-group/displayName.md rename {services/access-control => apis}/v2/operations/create-itwin-job/description.md (100%) create mode 100644 apis/v2/operations/create-itwin-job/displayName.md rename {services/access-control => apis}/v2/operations/delete-iTwin-role/description.md (100%) create mode 100644 apis/v2/operations/delete-iTwin-role/displayName.md rename {services/access-control => apis}/v2/operations/delete-itwin-group/description.md (100%) create mode 100644 apis/v2/operations/delete-itwin-group/displayName.md rename {services/access-control => apis}/v2/operations/get-all-permissions/description.md (100%) create mode 100644 apis/v2/operations/get-all-permissions/displayName.md rename {services/access-control => apis}/v2/operations/get-iTwin-permissions/description.md (100%) create mode 100644 apis/v2/operations/get-iTwin-permissions/displayName.md rename {services/access-control => apis}/v2/operations/get-iTwin-roles/description.md (100%) create mode 100644 apis/v2/operations/get-iTwin-roles/displayName.md rename {services/access-control => apis}/v2/operations/get-itwin-group-member/description.md (100%) create mode 100644 apis/v2/operations/get-itwin-group-member/displayName.md rename {services/access-control => apis}/v2/operations/get-itwin-group-members/description.md (100%) create mode 100644 apis/v2/operations/get-itwin-group-members/displayName.md rename {services/access-control => apis}/v2/operations/get-itwin-group/description.md (100%) create mode 100644 apis/v2/operations/get-itwin-group/displayName.md rename {services/access-control => apis}/v2/operations/get-itwin-groups/description.md (100%) create mode 100644 apis/v2/operations/get-itwin-groups/displayName.md rename {services/access-control => apis}/v2/operations/get-itwin-job-actions/description.md (100%) create mode 100644 apis/v2/operations/get-itwin-job-actions/displayName.md rename {services/access-control => apis}/v2/operations/get-itwin-job/description.md (100%) create mode 100644 apis/v2/operations/get-itwin-job/displayName.md rename {services/access-control => apis}/v2/operations/get-itwin-member-invitations/description.md (100%) create mode 100644 apis/v2/operations/get-itwin-member-invitations/displayName.md rename {services/access-control => apis}/v2/operations/get-itwin-owner-members/description.md (100%) create mode 100644 apis/v2/operations/get-itwin-owner-members/displayName.md rename {services/access-control => apis}/v2/operations/get-itwin-role/description.md (100%) create mode 100644 apis/v2/operations/get-itwin-role/displayName.md rename {services/access-control => apis}/v2/operations/get-itwin-user-member/description.md (100%) create mode 100644 apis/v2/operations/get-itwin-user-member/displayName.md rename {services/access-control => apis}/v2/operations/get-itwin-user-members/description.md (100%) create mode 100644 apis/v2/operations/get-itwin-user-members/displayName.md rename {services/access-control => apis}/v2/operations/remove-itwin-group-member/description.md (100%) create mode 100644 apis/v2/operations/remove-itwin-group-member/displayName.md rename {services/access-control => apis}/v2/operations/remove-itwin-owner-member/description.md (100%) create mode 100644 apis/v2/operations/remove-itwin-owner-member/displayName.md rename {services/access-control => apis}/v2/operations/remove-itwin-user-member/description.md (100%) create mode 100644 apis/v2/operations/remove-itwin-user-member/displayName.md rename {services/access-control => apis}/v2/operations/update-iTwin-role/description.md (100%) create mode 100644 apis/v2/operations/update-iTwin-role/displayName.md rename {services/access-control => apis}/v2/operations/update-itwin-group-member/description.md (100%) create mode 100644 apis/v2/operations/update-itwin-group-member/displayName.md rename {services/access-control => apis}/v2/operations/update-itwin-group/description.md (100%) create mode 100644 apis/v2/operations/update-itwin-group/displayName.md rename {services/access-control => apis}/v2/operations/update-itwin-user-member/description.md (100%) create mode 100644 apis/v2/operations/update-itwin-user-member/displayName.md rename {services => apis}/validation/v1/description.md (100%) rename {services => apis}/validation/v1/operations/create-validation-propertyvalue-rule/description.md (100%) rename {services => apis}/validation/v1/operations/create-validation-propertyvalue-rule/displayName.md (100%) rename {services => apis}/validation/v1/operations/create-validation-propertyvalue-tests/description.md (100%) rename {services => apis}/validation/v1/operations/create-validation-propertyvalue-tests/displayName.md (100%) rename {services => apis}/validation/v1/operations/delete-validation-propertyvalue-rule/description.md (100%) rename {services => apis}/validation/v1/operations/delete-validation-propertyvalue-rule/displayName.md (100%) rename {services => apis}/validation/v1/operations/delete-validation-propertyvalue-run/description.md (100%) rename {services => apis}/validation/v1/operations/delete-validation-propertyvalue-run/displayName.md (100%) rename {services => apis}/validation/v1/operations/delete-validation-propertyvalue-test/description.md (100%) rename {services => apis}/validation/v1/operations/delete-validation-propertyvalue-test/displayName.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-properties/description.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-properties/displayName.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-result/description.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-result/displayName.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-rule-templates/description.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-rule-templates/displayName.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-rule/description.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-rule/displayName.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-rules/description.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-rules/displayName.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-run/description.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-run/displayName.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-runs/description.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-runs/displayName.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-test/description.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-test/displayName.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-tests/description.md (100%) rename {services => apis}/validation/v1/operations/get-validation-propertyvalue-tests/displayName.md (100%) rename {services => apis}/validation/v1/operations/run-validation-propertyvalue-test/description.md (100%) rename {services => apis}/validation/v1/operations/run-validation-propertyvalue-test/displayName.md (100%) rename {services => apis}/validation/v1/operations/update-validation-propertyvalue-rule/description.md (100%) rename {services => apis}/validation/v1/operations/update-validation-propertyvalue-rule/displayName.md (100%) rename {services => apis}/validation/v1/operations/update-validation-propertyvalue-test/description.md (100%) rename {services => apis}/validation/v1/operations/update-validation-propertyvalue-test/displayName.md (100%) rename {services => apis}/webhooks/v2/description.md (100%) rename {services => apis}/webhooks/v2/operations/create-webhook/description.md (100%) rename {services => apis}/webhooks/v2/operations/create-webhook/displayName.md (100%) rename {services => apis}/webhooks/v2/operations/delete-webhook/description.md (100%) rename {services => apis}/webhooks/v2/operations/delete-webhook/displayName.md (100%) rename {services => apis}/webhooks/v2/operations/get-webhook/description.md (100%) rename {services => apis}/webhooks/v2/operations/get-webhook/displayName.md (100%) rename {services => apis}/webhooks/v2/operations/get-webhooks/description.md (100%) rename {services => apis}/webhooks/v2/operations/get-webhooks/displayName.md (100%) rename {services => apis}/webhooks/v2/operations/update-webhook/description.md (100%) rename {services => apis}/webhooks/v2/operations/update-webhook/displayName.md (100%) rename {apis => common}/operations/description/Authorization.md (100%) rename {apis => common}/operations/description/OrganizationAdministrator.md (100%) rename {apis => common}/operations/description/ProjectsDeprecated.md (100%) rename {apis => common}/operations/description/RateLimits.md (100%) rename {apis => common}/operations/description/RbacPermissions.md (100%) rename {apis => common}/operations/description/iTwinsRBACPermission.md (100%) diff --git a/apis/access-control/v2/description.md b/apis/access-control/v2/description.md new file mode 100644 index 0000000..7baf7e1 --- /dev/null +++ b/apis/access-control/v2/description.md @@ -0,0 +1,5 @@ +--- + +Manage Access Controls for your iTwin member using iTwin roles and permissions. + +--- \ No newline at end of file diff --git a/apis/access-control/v2/operations/add-itwin-group-members/description.md b/apis/access-control/v2/operations/add-itwin-group-members/description.md new file mode 100644 index 0000000..b521de9 --- /dev/null +++ b/apis/access-control/v2/operations/add-itwin-group-members/description.md @@ -0,0 +1,19 @@ +--- + +Add new iTwin group members + +The total number of roles assigned in this request must not exceed 50. This can be achieved with many different configurations. For example, 1 role can be assigned to 50 groups, or 5 roles can be assigned to 10 groups, both resulting in 50 role assignments. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `administration_invite_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/add-itwin-group-members/displayName.md b/apis/access-control/v2/operations/add-itwin-group-members/displayName.md similarity index 100% rename from services/access-control/v2/operations/add-itwin-group-members/displayName.md rename to apis/access-control/v2/operations/add-itwin-group-members/displayName.md diff --git a/apis/access-control/v2/operations/add-itwin-owner-member/description.md b/apis/access-control/v2/operations/add-itwin-owner-member/description.md new file mode 100644 index 0000000..939b763 --- /dev/null +++ b/apis/access-control/v2/operations/add-itwin-owner-member/description.md @@ -0,0 +1,23 @@ +--- + +Add new iTwin owner members. iTwin Owners are users which have full control over the iTwin. Each owner is granted all permissions on the iTwin, allowing them to perform any action on the iTwin they own. + +Users which are external (i.e. not in the same organization as the iTwin) are not automatically added to the iTwin. Instead, they're invited. Users which are not external, are immediately added as members on the iTwin. + +Invited individuals will recieve an invitation via Email, where they'll be prompted to accept the invitation. Upon accepting, they'll then become a member of the iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +You must be an owner to add other owners. + +### Authorization + +User must have the `administration_invite_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/add-itwin-owner-member/displayName.md b/apis/access-control/v2/operations/add-itwin-owner-member/displayName.md similarity index 100% rename from services/access-control/v2/operations/add-itwin-owner-member/displayName.md rename to apis/access-control/v2/operations/add-itwin-owner-member/displayName.md diff --git a/apis/access-control/v2/operations/add-itwin-user-members/description.md b/apis/access-control/v2/operations/add-itwin-user-members/description.md new file mode 100644 index 0000000..2c218d9 --- /dev/null +++ b/apis/access-control/v2/operations/add-itwin-user-members/description.md @@ -0,0 +1,21 @@ +--- + +Add or Invite new iTwin user members. Users which are external (i.e. not in the same organization as the iTwin) are not automatically added to the iTwin. Instead, they're invited. Users which are not external, are immediately added as members on the iTwin. + +Invited individuals will recieve an invitation via Email, where they'll be prompted to accept the invitation. Upon accepting, they'll then become a member of the iTwin. + +The total number of roles assigned in this request must not exceed 50. This can be achieved with many different configurations. For example, 1 role can be assigned to 50 users, or 5 roles can be assigned to 10 users, both resulting in 50 role assignments. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `administration_invite_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/add-itwin-user-members/displayName.md b/apis/access-control/v2/operations/add-itwin-user-members/displayName.md similarity index 100% rename from services/access-control/v2/operations/add-itwin-user-members/displayName.md rename to apis/access-control/v2/operations/add-itwin-user-members/displayName.md diff --git a/apis/access-control/v2/operations/create-iTwin-role/description.md b/apis/access-control/v2/operations/create-iTwin-role/description.md new file mode 100644 index 0000000..62c143d --- /dev/null +++ b/apis/access-control/v2/operations/create-iTwin-role/description.md @@ -0,0 +1,17 @@ +--- + +Create a new iTwin role. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `administration_manage_roles` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/create-iTwin-role/displayName.md b/apis/access-control/v2/operations/create-iTwin-role/displayName.md similarity index 100% rename from services/access-control/v2/operations/create-iTwin-role/displayName.md rename to apis/access-control/v2/operations/create-iTwin-role/displayName.md diff --git a/apis/access-control/v2/operations/create-itwin-group/description.md b/apis/access-control/v2/operations/create-itwin-group/description.md new file mode 100644 index 0000000..a2cf196 --- /dev/null +++ b/apis/access-control/v2/operations/create-itwin-group/description.md @@ -0,0 +1,19 @@ +--- + +Create a new iTwin group. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +A user can create a Group by being assigned the `administration_manage_groups` on the iTwin level. A user also can create a Group on an iTwin by either being an Organization Administrator for the Organization that owns the given iTwin, or an owner of the iTwin. + +For creation of Groups on the Account iTwin, the user must be an Organization Administrator for the Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +--- diff --git a/services/access-control/v2/operations/create-itwin-group/displayName.md b/apis/access-control/v2/operations/create-itwin-group/displayName.md similarity index 100% rename from services/access-control/v2/operations/create-itwin-group/displayName.md rename to apis/access-control/v2/operations/create-itwin-group/displayName.md diff --git a/apis/access-control/v2/operations/create-itwin-job/description.md b/apis/access-control/v2/operations/create-itwin-job/description.md new file mode 100644 index 0000000..d101c17 --- /dev/null +++ b/apis/access-control/v2/operations/create-itwin-job/description.md @@ -0,0 +1,27 @@ +--- + +Create a new iTwin job. iTwin jobs allow you to preform actions on an iTwin in bulk. + +Currently there are three types of supported actions: + +- `assignRoles` +- `unassignRoles` +- `removeMembers` + +Note: If the user being assigned roles in the `assignRoles` action is not a member of the iTwin, they will be added to the iTwin with the provided roles. + +`assignRoles` and `unassignRoles` actions have a limit of 100 roles per group of actions. `removeMembers` has a limit of 100 emails. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `{permission}` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/create-itwin-job/displayName.md b/apis/access-control/v2/operations/create-itwin-job/displayName.md similarity index 100% rename from services/access-control/v2/operations/create-itwin-job/displayName.md rename to apis/access-control/v2/operations/create-itwin-job/displayName.md diff --git a/apis/access-control/v2/operations/delete-iTwin-role/description.md b/apis/access-control/v2/operations/delete-iTwin-role/description.md new file mode 100644 index 0000000..b35426d --- /dev/null +++ b/apis/access-control/v2/operations/delete-iTwin-role/description.md @@ -0,0 +1,17 @@ +--- + +Delete the specified iTwin role. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `administration_manage_roles` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/delete-iTwin-role/displayName.md b/apis/access-control/v2/operations/delete-iTwin-role/displayName.md similarity index 100% rename from services/access-control/v2/operations/delete-iTwin-role/displayName.md rename to apis/access-control/v2/operations/delete-iTwin-role/displayName.md diff --git a/apis/access-control/v2/operations/delete-itwin-group/description.md b/apis/access-control/v2/operations/delete-itwin-group/description.md new file mode 100644 index 0000000..ae86084 --- /dev/null +++ b/apis/access-control/v2/operations/delete-itwin-group/description.md @@ -0,0 +1,19 @@ +--- + +Delete the specified iTwin group. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +A user can delete a Group by being assigned the `administration_manage_groups` on the iTwin level. A user also can delete a Group on an iTwin by either being an Organization Administrator for the Organization that owns the given iTwin, or an owner of the iTwin. + +For deletion of Groups on the Account iTwin, the user must be an Organization Administrator for the Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +--- diff --git a/services/access-control/v2/operations/delete-itwin-group/displayName.md b/apis/access-control/v2/operations/delete-itwin-group/displayName.md similarity index 100% rename from services/access-control/v2/operations/delete-itwin-group/displayName.md rename to apis/access-control/v2/operations/delete-itwin-group/displayName.md diff --git a/apis/access-control/v2/operations/get-all-permissions/description.md b/apis/access-control/v2/operations/get-all-permissions/description.md new file mode 100644 index 0000000..751f14a --- /dev/null +++ b/apis/access-control/v2/operations/get-all-permissions/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves the list of all available permissions + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +No Authorization is required for this API call. + +--- diff --git a/services/access-control/v2/operations/get-all-permissions/displayName.md b/apis/access-control/v2/operations/get-all-permissions/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-all-permissions/displayName.md rename to apis/access-control/v2/operations/get-all-permissions/displayName.md diff --git a/apis/access-control/v2/operations/get-iTwin-permissions/description.md b/apis/access-control/v2/operations/get-iTwin-permissions/description.md new file mode 100644 index 0000000..940454b --- /dev/null +++ b/apis/access-control/v2/operations/get-iTwin-permissions/description.md @@ -0,0 +1,15 @@ +--- + +Retrieves a list of permissions the calling user has on a specified iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +No Authorization is required for this API call. + +--- \ No newline at end of file diff --git a/services/access-control/v2/operations/get-iTwin-permissions/displayName.md b/apis/access-control/v2/operations/get-iTwin-permissions/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-iTwin-permissions/displayName.md rename to apis/access-control/v2/operations/get-iTwin-permissions/displayName.md diff --git a/apis/access-control/v2/operations/get-iTwin-roles/description.md b/apis/access-control/v2/operations/get-iTwin-roles/description.md new file mode 100644 index 0000000..eae28b4 --- /dev/null +++ b/apis/access-control/v2/operations/get-iTwin-roles/description.md @@ -0,0 +1,17 @@ +--- + +Retrieves a list of available user roles that are defined for a specified iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `administration_manage_roles` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-iTwin-roles/displayName.md b/apis/access-control/v2/operations/get-iTwin-roles/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-iTwin-roles/displayName.md rename to apis/access-control/v2/operations/get-iTwin-roles/displayName.md diff --git a/apis/access-control/v2/operations/get-itwin-group-member/description.md b/apis/access-control/v2/operations/get-itwin-group-member/description.md new file mode 100644 index 0000000..1d3994d --- /dev/null +++ b/apis/access-control/v2/operations/get-itwin-group-member/description.md @@ -0,0 +1,17 @@ +--- + +Retrieves a specific group member for a specified iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve an iTwin member for any iTwin in their Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-group-member/displayName.md b/apis/access-control/v2/operations/get-itwin-group-member/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-group-member/displayName.md rename to apis/access-control/v2/operations/get-itwin-group-member/displayName.md diff --git a/apis/access-control/v2/operations/get-itwin-group-members/description.md b/apis/access-control/v2/operations/get-itwin-group-members/description.md new file mode 100644 index 0000000..b88d78c --- /dev/null +++ b/apis/access-control/v2/operations/get-itwin-group-members/description.md @@ -0,0 +1,17 @@ +--- + +Retrieves a list of iTwin group members and their roles assignments. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin members for any iTwin in their Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-group-members/displayName.md b/apis/access-control/v2/operations/get-itwin-group-members/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-group-members/displayName.md rename to apis/access-control/v2/operations/get-itwin-group-members/displayName.md diff --git a/apis/access-control/v2/operations/get-itwin-group/description.md b/apis/access-control/v2/operations/get-itwin-group/description.md new file mode 100644 index 0000000..01a36b7 --- /dev/null +++ b/apis/access-control/v2/operations/get-itwin-group/description.md @@ -0,0 +1,17 @@ +--- + +Retrieves the specified group for the specified iTwin. The `members` and `imsGroups` properties are both capped at 50 each. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must be an Organization Administrator for the Organization that owns the given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-group/displayName.md b/apis/access-control/v2/operations/get-itwin-group/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-group/displayName.md rename to apis/access-control/v2/operations/get-itwin-group/displayName.md diff --git a/apis/access-control/v2/operations/get-itwin-groups/description.md b/apis/access-control/v2/operations/get-itwin-groups/description.md new file mode 100644 index 0000000..7088c5e --- /dev/null +++ b/apis/access-control/v2/operations/get-itwin-groups/description.md @@ -0,0 +1,17 @@ +--- + +Retrieves a list of all groups that are defined for a specified iTwin. The `members` and `imsGroups` properties are both capped at 50 each. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must be an Organization Administrator for the Organization that owns the given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-groups/displayName.md b/apis/access-control/v2/operations/get-itwin-groups/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-groups/displayName.md rename to apis/access-control/v2/operations/get-itwin-groups/displayName.md diff --git a/apis/access-control/v2/operations/get-itwin-job-actions/description.md b/apis/access-control/v2/operations/get-itwin-job-actions/description.md new file mode 100644 index 0000000..7a47fde --- /dev/null +++ b/apis/access-control/v2/operations/get-itwin-job-actions/description.md @@ -0,0 +1,17 @@ +--- + +Retrieves the iTwin job actions for the specified iTwin job for the specified iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `{permission}` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-job-actions/displayName.md b/apis/access-control/v2/operations/get-itwin-job-actions/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-job-actions/displayName.md rename to apis/access-control/v2/operations/get-itwin-job-actions/displayName.md diff --git a/apis/access-control/v2/operations/get-itwin-job/description.md b/apis/access-control/v2/operations/get-itwin-job/description.md new file mode 100644 index 0000000..bc9634b --- /dev/null +++ b/apis/access-control/v2/operations/get-itwin-job/description.md @@ -0,0 +1,26 @@ +--- + +Retrieves the specified iTwin job for the specified iTwin. + +By default this operation will only return the `status` of the iTwin job. To find the specific errors of the iTwin job, include `return=representation` in the `Prefer` header. + +### Status + +- `Active`: iTwin job is stil in progress. +- `Completed`: iTwin job completed without error. +- `PartialCompleted`: iTwin job completed with some actions failing. To find the specific errors of the iTwin job, include `return=representation` in the `Prefer` header. +- `Failed`: iTwin job completed with all actions failing. To find the specific errors of the iTwin job, include `return=representation` in the `Prefer` header. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `{permission}` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-job/displayName.md b/apis/access-control/v2/operations/get-itwin-job/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-job/displayName.md rename to apis/access-control/v2/operations/get-itwin-job/displayName.md diff --git a/apis/access-control/v2/operations/get-itwin-member-invitations/description.md b/apis/access-control/v2/operations/get-itwin-member-invitations/description.md new file mode 100644 index 0000000..85148e2 --- /dev/null +++ b/apis/access-control/v2/operations/get-itwin-member-invitations/description.md @@ -0,0 +1,13 @@ +--- + +Retrieves a list of iTwin member invitations. By default, users will receive the invitations they have sent. If the user is an iTwin Owner, they will receive all invitations for the iTwin. + +Invitations have an expiration of 7 days after their creation. Once that expiration passes, the invitation will not be returned. + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin member invitations for any iTwin in their Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-member-invitations/displayName.md b/apis/access-control/v2/operations/get-itwin-member-invitations/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-member-invitations/displayName.md rename to apis/access-control/v2/operations/get-itwin-member-invitations/displayName.md diff --git a/apis/access-control/v2/operations/get-itwin-owner-members/description.md b/apis/access-control/v2/operations/get-itwin-owner-members/description.md new file mode 100644 index 0000000..4c29298 --- /dev/null +++ b/apis/access-control/v2/operations/get-itwin-owner-members/description.md @@ -0,0 +1,38 @@ +--- + +Retrieves a list of iTwin owner members. iTwin Owners are users which have full control over the iTwin. Each owner is granted all permissions on the iTwin, allowing them to perform any action on the iTwin they own. + +### Missing Users + +When members are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a member of the iTwin. When this happens, the user member will be returned from this API endpoint with the follow values: +``` +{ + "id": , + "email": null, + "givenName": null, + "surname": null, + "organization": null, + ... +} +``` +You should account for this in your software if you do not want to show these users. + +#### Cleanup + +The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient. + +If not, you can use the [Remove iTwin Owner Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-owner-member/) API (use the memberId) to remove the owner member from the iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin owner members for any iTwin in their Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-owner-members/displayName.md b/apis/access-control/v2/operations/get-itwin-owner-members/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-owner-members/displayName.md rename to apis/access-control/v2/operations/get-itwin-owner-members/displayName.md diff --git a/apis/access-control/v2/operations/get-itwin-role/description.md b/apis/access-control/v2/operations/get-itwin-role/description.md new file mode 100644 index 0000000..838e369 --- /dev/null +++ b/apis/access-control/v2/operations/get-itwin-role/description.md @@ -0,0 +1,17 @@ +--- + +Retrieves the specified role for the specified iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `administration_manage_roles` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-role/displayName.md b/apis/access-control/v2/operations/get-itwin-role/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-role/displayName.md rename to apis/access-control/v2/operations/get-itwin-role/displayName.md diff --git a/apis/access-control/v2/operations/get-itwin-user-member/description.md b/apis/access-control/v2/operations/get-itwin-user-member/description.md new file mode 100644 index 0000000..a669cb6 --- /dev/null +++ b/apis/access-control/v2/operations/get-itwin-user-member/description.md @@ -0,0 +1,38 @@ +--- + +Retrieves a specific user member for a specified iTwin. + +### Missing Users + +When users are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a user member of the iTwin. When this happens, the user member will be returned from this API endpoint with the follow values: +``` +{ + "id": , + "email": null, + "givenName": null, + "surname": null, + "organization": null, + ... +} +``` +You should account for this in your software if you do not want to show these users. + +#### Cleanup + +The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient. + +If not, you can use the [Remove iTwin User Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-user-member/) API (use the memberId) to remove the user member from the iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve an iTwin user member for any iTwin in their Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-user-member/displayName.md b/apis/access-control/v2/operations/get-itwin-user-member/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-user-member/displayName.md rename to apis/access-control/v2/operations/get-itwin-user-member/displayName.md diff --git a/apis/access-control/v2/operations/get-itwin-user-members/description.md b/apis/access-control/v2/operations/get-itwin-user-members/description.md new file mode 100644 index 0000000..4e7001e --- /dev/null +++ b/apis/access-control/v2/operations/get-itwin-user-members/description.md @@ -0,0 +1,38 @@ +--- + +Retrieves a list of iTwin user members and their roles assignments. + +### Missing Users + +When members are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a member of the iTwin. When this happens, the user member will be returned from this API endpoint with the follow values: +``` +{ + "id": , + "email": null, + "givenName": null, + "surname": null, + "organization": null, + ... +} +``` +You should account for this in your software if you do not want to show these users. + +#### Cleanup + +The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient. + +If not, you can use the [Remove iTwin User Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-user-member/) API (use the memberId) to remove the user member from the iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin user members for any iTwin in their Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/get-itwin-user-members/displayName.md b/apis/access-control/v2/operations/get-itwin-user-members/displayName.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-user-members/displayName.md rename to apis/access-control/v2/operations/get-itwin-user-members/displayName.md diff --git a/apis/access-control/v2/operations/remove-itwin-group-member/description.md b/apis/access-control/v2/operations/remove-itwin-group-member/description.md new file mode 100644 index 0000000..f0d236d --- /dev/null +++ b/apis/access-control/v2/operations/remove-itwin-group-member/description.md @@ -0,0 +1,17 @@ +--- + +Remove the specified group member from the iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `administration_remove_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/remove-itwin-group-member/displayName.md b/apis/access-control/v2/operations/remove-itwin-group-member/displayName.md similarity index 100% rename from services/access-control/v2/operations/remove-itwin-group-member/displayName.md rename to apis/access-control/v2/operations/remove-itwin-group-member/displayName.md diff --git a/apis/access-control/v2/operations/remove-itwin-owner-member/description.md b/apis/access-control/v2/operations/remove-itwin-owner-member/description.md new file mode 100644 index 0000000..113c8c7 --- /dev/null +++ b/apis/access-control/v2/operations/remove-itwin-owner-member/description.md @@ -0,0 +1,19 @@ +--- + +Remove the specified owner from the iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +You must be an owner to remove other owners. + +### Authorization + +User must have the `administration_remove_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/remove-itwin-owner-member/displayName.md b/apis/access-control/v2/operations/remove-itwin-owner-member/displayName.md similarity index 100% rename from services/access-control/v2/operations/remove-itwin-owner-member/displayName.md rename to apis/access-control/v2/operations/remove-itwin-owner-member/displayName.md diff --git a/apis/access-control/v2/operations/remove-itwin-user-member/description.md b/apis/access-control/v2/operations/remove-itwin-user-member/description.md new file mode 100644 index 0000000..86e534f --- /dev/null +++ b/apis/access-control/v2/operations/remove-itwin-user-member/description.md @@ -0,0 +1,17 @@ +--- + +Remove the specified user member from the iTwin. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `administration_remove_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/remove-itwin-user-member/displayName.md b/apis/access-control/v2/operations/remove-itwin-user-member/displayName.md similarity index 100% rename from services/access-control/v2/operations/remove-itwin-user-member/displayName.md rename to apis/access-control/v2/operations/remove-itwin-user-member/displayName.md diff --git a/apis/access-control/v2/operations/update-iTwin-role/description.md b/apis/access-control/v2/operations/update-iTwin-role/description.md new file mode 100644 index 0000000..a4f0e3f --- /dev/null +++ b/apis/access-control/v2/operations/update-iTwin-role/description.md @@ -0,0 +1,17 @@ +--- + +Update the specified iTwin role. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `administration_manage_roles` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/update-iTwin-role/displayName.md b/apis/access-control/v2/operations/update-iTwin-role/displayName.md similarity index 100% rename from services/access-control/v2/operations/update-iTwin-role/displayName.md rename to apis/access-control/v2/operations/update-iTwin-role/displayName.md diff --git a/apis/access-control/v2/operations/update-itwin-group-member/description.md b/apis/access-control/v2/operations/update-itwin-group-member/description.md new file mode 100644 index 0000000..a7a8f3a --- /dev/null +++ b/apis/access-control/v2/operations/update-itwin-group-member/description.md @@ -0,0 +1,17 @@ +--- + +Update an iTwin group member's role assignments + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `administration_invite_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/update-itwin-group-member/displayName.md b/apis/access-control/v2/operations/update-itwin-group-member/displayName.md similarity index 100% rename from services/access-control/v2/operations/update-itwin-group-member/displayName.md rename to apis/access-control/v2/operations/update-itwin-group-member/displayName.md diff --git a/apis/access-control/v2/operations/update-itwin-group/description.md b/apis/access-control/v2/operations/update-itwin-group/description.md new file mode 100644 index 0000000..3eccaa1 --- /dev/null +++ b/apis/access-control/v2/operations/update-itwin-group/description.md @@ -0,0 +1,21 @@ +--- + +Update the specified iTwin group. The `members` and `imsGroups` properties are both capped at 50 each. + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +A user can update a Group by being assigned the `administration_manage_groups` on the iTwin level. If the user is adding members or IMS groups they must also have the `administration_invite_member` permission assigned at the iTwin level. If the user is removing members or IMS groups they must also have the `administration_remove_member` permission assigned at the iTwin level. + +A user also can update a Group on an iTwin by either being an Organization Administrator for the Organization that owns the given iTwin, or an owner of the iTwin. + +To update a Group on the Account iTwin, the user must be an Organization Administrator for the Organization. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page + +--- diff --git a/services/access-control/v2/operations/update-itwin-group/displayName.md b/apis/access-control/v2/operations/update-itwin-group/displayName.md similarity index 100% rename from services/access-control/v2/operations/update-itwin-group/displayName.md rename to apis/access-control/v2/operations/update-itwin-group/displayName.md diff --git a/apis/access-control/v2/operations/update-itwin-user-member/description.md b/apis/access-control/v2/operations/update-itwin-user-member/description.md new file mode 100644 index 0000000..420e618 --- /dev/null +++ b/apis/access-control/v2/operations/update-itwin-user-member/description.md @@ -0,0 +1,17 @@ +--- + +Update an iTwin user member's role assignments + +### Authentication + +Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. + +For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. + +### Authorization + +User must have the `administration_invite_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. + +An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. + +--- diff --git a/services/access-control/v2/operations/update-itwin-user-member/displayName.md b/apis/access-control/v2/operations/update-itwin-user-member/displayName.md similarity index 100% rename from services/access-control/v2/operations/update-itwin-user-member/displayName.md rename to apis/access-control/v2/operations/update-itwin-user-member/displayName.md diff --git a/services/carbon-calculation/v1/description.md b/apis/carbon-calculation/v1/description.md similarity index 100% rename from services/carbon-calculation/v1/description.md rename to apis/carbon-calculation/v1/description.md diff --git a/services/carbon-calculation/v1/operations/create-ec3-configuration/description.md b/apis/carbon-calculation/v1/operations/create-ec3-configuration/description.md similarity index 100% rename from services/carbon-calculation/v1/operations/create-ec3-configuration/description.md rename to apis/carbon-calculation/v1/operations/create-ec3-configuration/description.md diff --git a/services/carbon-calculation/v1/operations/create-ec3-configuration/displayName.md b/apis/carbon-calculation/v1/operations/create-ec3-configuration/displayName.md similarity index 100% rename from services/carbon-calculation/v1/operations/create-ec3-configuration/displayName.md rename to apis/carbon-calculation/v1/operations/create-ec3-configuration/displayName.md diff --git a/services/carbon-calculation/v1/operations/create-ec3-job/description.md b/apis/carbon-calculation/v1/operations/create-ec3-job/description.md similarity index 100% rename from services/carbon-calculation/v1/operations/create-ec3-job/description.md rename to apis/carbon-calculation/v1/operations/create-ec3-job/description.md diff --git a/services/carbon-calculation/v1/operations/create-ec3-job/displayName.md b/apis/carbon-calculation/v1/operations/create-ec3-job/displayName.md similarity index 100% rename from services/carbon-calculation/v1/operations/create-ec3-job/displayName.md rename to apis/carbon-calculation/v1/operations/create-ec3-job/displayName.md diff --git a/services/carbon-calculation/v1/operations/create-oneclicklca-job/description.md b/apis/carbon-calculation/v1/operations/create-oneclicklca-job/description.md similarity index 100% rename from services/carbon-calculation/v1/operations/create-oneclicklca-job/description.md rename to apis/carbon-calculation/v1/operations/create-oneclicklca-job/description.md diff --git a/services/carbon-calculation/v1/operations/create-oneclicklca-job/displayName.md b/apis/carbon-calculation/v1/operations/create-oneclicklca-job/displayName.md similarity index 100% rename from services/carbon-calculation/v1/operations/create-oneclicklca-job/displayName.md rename to apis/carbon-calculation/v1/operations/create-oneclicklca-job/displayName.md diff --git a/services/carbon-calculation/v1/operations/delete-ec3-configuration/description.md b/apis/carbon-calculation/v1/operations/delete-ec3-configuration/description.md similarity index 100% rename from services/carbon-calculation/v1/operations/delete-ec3-configuration/description.md rename to apis/carbon-calculation/v1/operations/delete-ec3-configuration/description.md diff --git a/services/carbon-calculation/v1/operations/delete-ec3-configuration/displayName.md b/apis/carbon-calculation/v1/operations/delete-ec3-configuration/displayName.md similarity index 100% rename from services/carbon-calculation/v1/operations/delete-ec3-configuration/displayName.md rename to apis/carbon-calculation/v1/operations/delete-ec3-configuration/displayName.md diff --git a/services/carbon-calculation/v1/operations/get-ec3-configuration/description.md b/apis/carbon-calculation/v1/operations/get-ec3-configuration/description.md similarity index 100% rename from services/carbon-calculation/v1/operations/get-ec3-configuration/description.md rename to apis/carbon-calculation/v1/operations/get-ec3-configuration/description.md diff --git a/services/carbon-calculation/v1/operations/get-ec3-configuration/displayName.md b/apis/carbon-calculation/v1/operations/get-ec3-configuration/displayName.md similarity index 100% rename from services/carbon-calculation/v1/operations/get-ec3-configuration/displayName.md rename to apis/carbon-calculation/v1/operations/get-ec3-configuration/displayName.md diff --git a/services/carbon-calculation/v1/operations/get-ec3-configurations/description.md b/apis/carbon-calculation/v1/operations/get-ec3-configurations/description.md similarity index 100% rename from services/carbon-calculation/v1/operations/get-ec3-configurations/description.md rename to apis/carbon-calculation/v1/operations/get-ec3-configurations/description.md diff --git a/services/carbon-calculation/v1/operations/get-ec3-configurations/displayName.md b/apis/carbon-calculation/v1/operations/get-ec3-configurations/displayName.md similarity index 100% rename from services/carbon-calculation/v1/operations/get-ec3-configurations/displayName.md rename to apis/carbon-calculation/v1/operations/get-ec3-configurations/displayName.md diff --git a/services/carbon-calculation/v1/operations/get-ec3-job-status/description.md b/apis/carbon-calculation/v1/operations/get-ec3-job-status/description.md similarity index 100% rename from services/carbon-calculation/v1/operations/get-ec3-job-status/description.md rename to apis/carbon-calculation/v1/operations/get-ec3-job-status/description.md diff --git a/services/carbon-calculation/v1/operations/get-ec3-job-status/displayName.md b/apis/carbon-calculation/v1/operations/get-ec3-job-status/displayName.md similarity index 100% rename from services/carbon-calculation/v1/operations/get-ec3-job-status/displayName.md rename to apis/carbon-calculation/v1/operations/get-ec3-job-status/displayName.md diff --git a/services/carbon-calculation/v1/operations/get-oneclicklca-job-status/description.md b/apis/carbon-calculation/v1/operations/get-oneclicklca-job-status/description.md similarity index 100% rename from services/carbon-calculation/v1/operations/get-oneclicklca-job-status/description.md rename to apis/carbon-calculation/v1/operations/get-oneclicklca-job-status/description.md diff --git a/services/carbon-calculation/v1/operations/get-oneclicklca-job-status/displayName.md b/apis/carbon-calculation/v1/operations/get-oneclicklca-job-status/displayName.md similarity index 100% rename from services/carbon-calculation/v1/operations/get-oneclicklca-job-status/displayName.md rename to apis/carbon-calculation/v1/operations/get-oneclicklca-job-status/displayName.md diff --git a/services/carbon-calculation/v1/operations/update-ec3-configuration/description.md b/apis/carbon-calculation/v1/operations/update-ec3-configuration/description.md similarity index 100% rename from services/carbon-calculation/v1/operations/update-ec3-configuration/description.md rename to apis/carbon-calculation/v1/operations/update-ec3-configuration/description.md diff --git a/services/carbon-calculation/v1/operations/update-ec3-configuration/displayName.md b/apis/carbon-calculation/v1/operations/update-ec3-configuration/displayName.md similarity index 100% rename from services/carbon-calculation/v1/operations/update-ec3-configuration/displayName.md rename to apis/carbon-calculation/v1/operations/update-ec3-configuration/displayName.md diff --git a/services/changed-elements/v2/description.md b/apis/changed-elements/v2/description.md similarity index 100% rename from services/changed-elements/v2/description.md rename to apis/changed-elements/v2/description.md diff --git a/services/changed-elements/v2/operations/create-comparison-job/description.md b/apis/changed-elements/v2/operations/create-comparison-job/description.md similarity index 100% rename from services/changed-elements/v2/operations/create-comparison-job/description.md rename to apis/changed-elements/v2/operations/create-comparison-job/description.md diff --git a/services/changed-elements/v2/operations/create-comparison-job/displayName.md b/apis/changed-elements/v2/operations/create-comparison-job/displayName.md similarity index 100% rename from services/changed-elements/v2/operations/create-comparison-job/displayName.md rename to apis/changed-elements/v2/operations/create-comparison-job/displayName.md diff --git a/services/changed-elements/v2/operations/delete-comparison-job/description.md b/apis/changed-elements/v2/operations/delete-comparison-job/description.md similarity index 100% rename from services/changed-elements/v2/operations/delete-comparison-job/description.md rename to apis/changed-elements/v2/operations/delete-comparison-job/description.md diff --git a/services/changed-elements/v2/operations/delete-comparison-job/displayName.md b/apis/changed-elements/v2/operations/delete-comparison-job/displayName.md similarity index 100% rename from services/changed-elements/v2/operations/delete-comparison-job/displayName.md rename to apis/changed-elements/v2/operations/delete-comparison-job/displayName.md diff --git a/services/changed-elements/v2/operations/get-comparison-job/description.md b/apis/changed-elements/v2/operations/get-comparison-job/description.md similarity index 100% rename from services/changed-elements/v2/operations/get-comparison-job/description.md rename to apis/changed-elements/v2/operations/get-comparison-job/description.md diff --git a/services/changed-elements/v2/operations/get-comparison-job/displayName.md b/apis/changed-elements/v2/operations/get-comparison-job/displayName.md similarity index 100% rename from services/changed-elements/v2/operations/get-comparison-job/displayName.md rename to apis/changed-elements/v2/operations/get-comparison-job/displayName.md diff --git a/services/clash-detection/v2/description.md b/apis/clash-detection/v2/description.md similarity index 100% rename from services/clash-detection/v2/description.md rename to apis/clash-detection/v2/description.md diff --git a/services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/description.md b/apis/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/description.md similarity index 100% rename from services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/description.md rename to apis/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/description.md diff --git a/services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/displayName.md b/apis/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/displayName.md rename to apis/clash-detection/v2/operations/apply-clashdetection-manual-suppression-rules/displayName.md diff --git a/services/clash-detection/v2/operations/cancel-clashdetection-run/description.md b/apis/clash-detection/v2/operations/cancel-clashdetection-run/description.md similarity index 100% rename from services/clash-detection/v2/operations/cancel-clashdetection-run/description.md rename to apis/clash-detection/v2/operations/cancel-clashdetection-run/description.md diff --git a/services/clash-detection/v2/operations/cancel-clashdetection-run/displayName.md b/apis/clash-detection/v2/operations/cancel-clashdetection-run/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/cancel-clashdetection-run/displayName.md rename to apis/clash-detection/v2/operations/cancel-clashdetection-run/displayName.md diff --git a/services/clash-detection/v2/operations/create-clashdetection-suppression-rule/description.md b/apis/clash-detection/v2/operations/create-clashdetection-suppression-rule/description.md similarity index 100% rename from services/clash-detection/v2/operations/create-clashdetection-suppression-rule/description.md rename to apis/clash-detection/v2/operations/create-clashdetection-suppression-rule/description.md diff --git a/services/clash-detection/v2/operations/create-clashdetection-suppression-rule/displayName.md b/apis/clash-detection/v2/operations/create-clashdetection-suppression-rule/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/create-clashdetection-suppression-rule/displayName.md rename to apis/clash-detection/v2/operations/create-clashdetection-suppression-rule/displayName.md diff --git a/services/clash-detection/v2/operations/create-clashdetection-tests/description.md b/apis/clash-detection/v2/operations/create-clashdetection-tests/description.md similarity index 100% rename from services/clash-detection/v2/operations/create-clashdetection-tests/description.md rename to apis/clash-detection/v2/operations/create-clashdetection-tests/description.md diff --git a/services/clash-detection/v2/operations/create-clashdetection-tests/displayName.md b/apis/clash-detection/v2/operations/create-clashdetection-tests/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/create-clashdetection-tests/displayName.md rename to apis/clash-detection/v2/operations/create-clashdetection-tests/displayName.md diff --git a/services/clash-detection/v2/operations/delete-clashdetection-run/description.md b/apis/clash-detection/v2/operations/delete-clashdetection-run/description.md similarity index 100% rename from services/clash-detection/v2/operations/delete-clashdetection-run/description.md rename to apis/clash-detection/v2/operations/delete-clashdetection-run/description.md diff --git a/services/clash-detection/v2/operations/delete-clashdetection-run/displayName.md b/apis/clash-detection/v2/operations/delete-clashdetection-run/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/delete-clashdetection-run/displayName.md rename to apis/clash-detection/v2/operations/delete-clashdetection-run/displayName.md diff --git a/services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/description.md b/apis/clash-detection/v2/operations/delete-clashdetection-suppression-rule/description.md similarity index 100% rename from services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/description.md rename to apis/clash-detection/v2/operations/delete-clashdetection-suppression-rule/description.md diff --git a/services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/displayName.md b/apis/clash-detection/v2/operations/delete-clashdetection-suppression-rule/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/delete-clashdetection-suppression-rule/displayName.md rename to apis/clash-detection/v2/operations/delete-clashdetection-suppression-rule/displayName.md diff --git a/services/clash-detection/v2/operations/delete-clashdetection-test/description.md b/apis/clash-detection/v2/operations/delete-clashdetection-test/description.md similarity index 100% rename from services/clash-detection/v2/operations/delete-clashdetection-test/description.md rename to apis/clash-detection/v2/operations/delete-clashdetection-test/description.md diff --git a/services/clash-detection/v2/operations/delete-clashdetection-test/displayName.md b/apis/clash-detection/v2/operations/delete-clashdetection-test/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/delete-clashdetection-test/displayName.md rename to apis/clash-detection/v2/operations/delete-clashdetection-test/displayName.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/description.md b/apis/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/description.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/description.md rename to apis/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/description.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/displayName.md b/apis/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/displayName.md rename to apis/clash-detection/v2/operations/get-clashdetection-manual-suppression-rules/displayName.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-result/description.md b/apis/clash-detection/v2/operations/get-clashdetection-result/description.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-result/description.md rename to apis/clash-detection/v2/operations/get-clashdetection-result/description.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-result/displayName.md b/apis/clash-detection/v2/operations/get-clashdetection-result/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-result/displayName.md rename to apis/clash-detection/v2/operations/get-clashdetection-result/displayName.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-results/description.md b/apis/clash-detection/v2/operations/get-clashdetection-results/description.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-results/description.md rename to apis/clash-detection/v2/operations/get-clashdetection-results/description.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-results/displayName.md b/apis/clash-detection/v2/operations/get-clashdetection-results/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-results/displayName.md rename to apis/clash-detection/v2/operations/get-clashdetection-results/displayName.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-suppression-rule/description.md b/apis/clash-detection/v2/operations/get-clashdetection-suppression-rule/description.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-suppression-rule/description.md rename to apis/clash-detection/v2/operations/get-clashdetection-suppression-rule/description.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-suppression-rule/displayName.md b/apis/clash-detection/v2/operations/get-clashdetection-suppression-rule/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-suppression-rule/displayName.md rename to apis/clash-detection/v2/operations/get-clashdetection-suppression-rule/displayName.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-suppression-rules/description.md b/apis/clash-detection/v2/operations/get-clashdetection-suppression-rules/description.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-suppression-rules/description.md rename to apis/clash-detection/v2/operations/get-clashdetection-suppression-rules/description.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-suppression-rules/displayName.md b/apis/clash-detection/v2/operations/get-clashdetection-suppression-rules/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-suppression-rules/displayName.md rename to apis/clash-detection/v2/operations/get-clashdetection-suppression-rules/displayName.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-test/description.md b/apis/clash-detection/v2/operations/get-clashdetection-test/description.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-test/description.md rename to apis/clash-detection/v2/operations/get-clashdetection-test/description.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-test/displayName.md b/apis/clash-detection/v2/operations/get-clashdetection-test/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-test/displayName.md rename to apis/clash-detection/v2/operations/get-clashdetection-test/displayName.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-tests/description.md b/apis/clash-detection/v2/operations/get-clashdetection-tests/description.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-tests/description.md rename to apis/clash-detection/v2/operations/get-clashdetection-tests/description.md diff --git a/services/clash-detection/v2/operations/get-clashdetection-tests/displayName.md b/apis/clash-detection/v2/operations/get-clashdetection-tests/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/get-clashdetection-tests/displayName.md rename to apis/clash-detection/v2/operations/get-clashdetection-tests/displayName.md diff --git a/services/clash-detection/v2/operations/get-suppression-rule-templates/description.md b/apis/clash-detection/v2/operations/get-suppression-rule-templates/description.md similarity index 100% rename from services/clash-detection/v2/operations/get-suppression-rule-templates/description.md rename to apis/clash-detection/v2/operations/get-suppression-rule-templates/description.md diff --git a/services/clash-detection/v2/operations/get-suppression-rule-templates/displayName.md b/apis/clash-detection/v2/operations/get-suppression-rule-templates/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/get-suppression-rule-templates/displayName.md rename to apis/clash-detection/v2/operations/get-suppression-rule-templates/displayName.md diff --git a/services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/description.md b/apis/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/description.md similarity index 100% rename from services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/description.md rename to apis/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/description.md diff --git a/services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/displayName.md b/apis/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/displayName.md rename to apis/clash-detection/v2/operations/remove-clashdetection-manual-suppression-rules/displayName.md diff --git a/services/clash-detection/v2/operations/run-clashdetection-test/description.md b/apis/clash-detection/v2/operations/run-clashdetection-test/description.md similarity index 100% rename from services/clash-detection/v2/operations/run-clashdetection-test/description.md rename to apis/clash-detection/v2/operations/run-clashdetection-test/description.md diff --git a/services/clash-detection/v2/operations/run-clashdetection-test/displayName.md b/apis/clash-detection/v2/operations/run-clashdetection-test/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/run-clashdetection-test/displayName.md rename to apis/clash-detection/v2/operations/run-clashdetection-test/displayName.md diff --git a/services/clash-detection/v2/operations/update-clashdetection-suppression-rule/description.md b/apis/clash-detection/v2/operations/update-clashdetection-suppression-rule/description.md similarity index 100% rename from services/clash-detection/v2/operations/update-clashdetection-suppression-rule/description.md rename to apis/clash-detection/v2/operations/update-clashdetection-suppression-rule/description.md diff --git a/services/clash-detection/v2/operations/update-clashdetection-suppression-rule/displayName.md b/apis/clash-detection/v2/operations/update-clashdetection-suppression-rule/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/update-clashdetection-suppression-rule/displayName.md rename to apis/clash-detection/v2/operations/update-clashdetection-suppression-rule/displayName.md diff --git a/services/clash-detection/v2/operations/update-clashdetection-test/description.md b/apis/clash-detection/v2/operations/update-clashdetection-test/description.md similarity index 100% rename from services/clash-detection/v2/operations/update-clashdetection-test/description.md rename to apis/clash-detection/v2/operations/update-clashdetection-test/description.md diff --git a/services/clash-detection/v2/operations/update-clashdetection-test/displayName.md b/apis/clash-detection/v2/operations/update-clashdetection-test/displayName.md similarity index 100% rename from services/clash-detection/v2/operations/update-clashdetection-test/displayName.md rename to apis/clash-detection/v2/operations/update-clashdetection-test/displayName.md diff --git a/services/contextcapture/v1/description.md b/apis/contextcapture/v1/description.md similarity index 100% rename from services/contextcapture/v1/description.md rename to apis/contextcapture/v1/description.md diff --git a/services/contextcapture/v1/operations/jobs-create/description.md b/apis/contextcapture/v1/operations/jobs-create/description.md similarity index 100% rename from services/contextcapture/v1/operations/jobs-create/description.md rename to apis/contextcapture/v1/operations/jobs-create/description.md diff --git a/services/contextcapture/v1/operations/jobs-create/displayName.md b/apis/contextcapture/v1/operations/jobs-create/displayName.md similarity index 100% rename from services/contextcapture/v1/operations/jobs-create/displayName.md rename to apis/contextcapture/v1/operations/jobs-create/displayName.md diff --git a/services/contextcapture/v1/operations/jobs-delete/description.md b/apis/contextcapture/v1/operations/jobs-delete/description.md similarity index 100% rename from services/contextcapture/v1/operations/jobs-delete/description.md rename to apis/contextcapture/v1/operations/jobs-delete/description.md diff --git a/services/contextcapture/v1/operations/jobs-delete/displayName.md b/apis/contextcapture/v1/operations/jobs-delete/displayName.md similarity index 100% rename from services/contextcapture/v1/operations/jobs-delete/displayName.md rename to apis/contextcapture/v1/operations/jobs-delete/displayName.md diff --git a/services/contextcapture/v1/operations/jobs-get/description.md b/apis/contextcapture/v1/operations/jobs-get/description.md similarity index 100% rename from services/contextcapture/v1/operations/jobs-get/description.md rename to apis/contextcapture/v1/operations/jobs-get/description.md diff --git a/services/contextcapture/v1/operations/jobs-get/displayName.md b/apis/contextcapture/v1/operations/jobs-get/displayName.md similarity index 100% rename from services/contextcapture/v1/operations/jobs-get/displayName.md rename to apis/contextcapture/v1/operations/jobs-get/displayName.md diff --git a/services/contextcapture/v1/operations/jobs-patch/description.md b/apis/contextcapture/v1/operations/jobs-patch/description.md similarity index 100% rename from services/contextcapture/v1/operations/jobs-patch/description.md rename to apis/contextcapture/v1/operations/jobs-patch/description.md diff --git a/services/contextcapture/v1/operations/jobs-patch/displayName.md b/apis/contextcapture/v1/operations/jobs-patch/displayName.md similarity index 100% rename from services/contextcapture/v1/operations/jobs-patch/displayName.md rename to apis/contextcapture/v1/operations/jobs-patch/displayName.md diff --git a/services/contextcapture/v1/operations/jobs-progress/description.md b/apis/contextcapture/v1/operations/jobs-progress/description.md similarity index 100% rename from services/contextcapture/v1/operations/jobs-progress/description.md rename to apis/contextcapture/v1/operations/jobs-progress/description.md diff --git a/services/contextcapture/v1/operations/jobs-progress/displayName.md b/apis/contextcapture/v1/operations/jobs-progress/displayName.md similarity index 100% rename from services/contextcapture/v1/operations/jobs-progress/displayName.md rename to apis/contextcapture/v1/operations/jobs-progress/displayName.md diff --git a/services/contextcapture/v1/operations/limits-engines/description.md b/apis/contextcapture/v1/operations/limits-engines/description.md similarity index 100% rename from services/contextcapture/v1/operations/limits-engines/description.md rename to apis/contextcapture/v1/operations/limits-engines/description.md diff --git a/services/contextcapture/v1/operations/limits-engines/displayName.md b/apis/contextcapture/v1/operations/limits-engines/displayName.md similarity index 100% rename from services/contextcapture/v1/operations/limits-engines/displayName.md rename to apis/contextcapture/v1/operations/limits-engines/displayName.md diff --git a/services/contextcapture/v1/operations/workspaces-create/description.md b/apis/contextcapture/v1/operations/workspaces-create/description.md similarity index 100% rename from services/contextcapture/v1/operations/workspaces-create/description.md rename to apis/contextcapture/v1/operations/workspaces-create/description.md diff --git a/services/contextcapture/v1/operations/workspaces-create/displayName.md b/apis/contextcapture/v1/operations/workspaces-create/displayName.md similarity index 100% rename from services/contextcapture/v1/operations/workspaces-create/displayName.md rename to apis/contextcapture/v1/operations/workspaces-create/displayName.md diff --git a/services/contextcapture/v1/operations/workspaces-delete/description.md b/apis/contextcapture/v1/operations/workspaces-delete/description.md similarity index 100% rename from services/contextcapture/v1/operations/workspaces-delete/description.md rename to apis/contextcapture/v1/operations/workspaces-delete/description.md diff --git a/services/contextcapture/v1/operations/workspaces-delete/displayName.md b/apis/contextcapture/v1/operations/workspaces-delete/displayName.md similarity index 100% rename from services/contextcapture/v1/operations/workspaces-delete/displayName.md rename to apis/contextcapture/v1/operations/workspaces-delete/displayName.md diff --git a/services/contextcapture/v1/operations/workspaces-get/description.md b/apis/contextcapture/v1/operations/workspaces-get/description.md similarity index 100% rename from services/contextcapture/v1/operations/workspaces-get/description.md rename to apis/contextcapture/v1/operations/workspaces-get/description.md diff --git a/services/contextcapture/v1/operations/workspaces-get/displayName.md b/apis/contextcapture/v1/operations/workspaces-get/displayName.md similarity index 100% rename from services/contextcapture/v1/operations/workspaces-get/displayName.md rename to apis/contextcapture/v1/operations/workspaces-get/displayName.md diff --git a/services/echo/v2/description.md b/apis/echo/v2/description.md similarity index 100% rename from services/echo/v2/description.md rename to apis/echo/v2/description.md diff --git a/services/echo/v2/operations/context-nested-parameter/description.md b/apis/echo/v2/operations/context-nested-parameter/description.md similarity index 100% rename from services/echo/v2/operations/context-nested-parameter/description.md rename to apis/echo/v2/operations/context-nested-parameter/description.md diff --git a/services/echo/v2/operations/context-nested-parameter/displayName.md b/apis/echo/v2/operations/context-nested-parameter/displayName.md similarity index 100% rename from services/echo/v2/operations/context-nested-parameter/displayName.md rename to apis/echo/v2/operations/context-nested-parameter/displayName.md diff --git a/services/echo/v2/operations/context-parameter/description.md b/apis/echo/v2/operations/context-parameter/description.md similarity index 100% rename from services/echo/v2/operations/context-parameter/description.md rename to apis/echo/v2/operations/context-parameter/description.md diff --git a/services/echo/v2/operations/context-parameter/displayName.md b/apis/echo/v2/operations/context-parameter/displayName.md similarity index 100% rename from services/echo/v2/operations/context-parameter/displayName.md rename to apis/echo/v2/operations/context-parameter/displayName.md diff --git a/services/echo/v2/operations/context/description.md b/apis/echo/v2/operations/context/description.md similarity index 100% rename from services/echo/v2/operations/context/description.md rename to apis/echo/v2/operations/context/description.md diff --git a/services/echo/v2/operations/context/displayName.md b/apis/echo/v2/operations/context/displayName.md similarity index 100% rename from services/echo/v2/operations/context/displayName.md rename to apis/echo/v2/operations/context/displayName.md diff --git a/services/export/v1/description.md b/apis/export/v1/description.md similarity index 100% rename from services/export/v1/description.md rename to apis/export/v1/description.md diff --git a/services/export/v1/operations/create-export-connection-run/description.md b/apis/export/v1/operations/create-export-connection-run/description.md similarity index 100% rename from services/export/v1/operations/create-export-connection-run/description.md rename to apis/export/v1/operations/create-export-connection-run/description.md diff --git a/services/export/v1/operations/create-export-connection-run/displayName.md b/apis/export/v1/operations/create-export-connection-run/displayName.md similarity index 100% rename from services/export/v1/operations/create-export-connection-run/displayName.md rename to apis/export/v1/operations/create-export-connection-run/displayName.md diff --git a/services/export/v1/operations/create-export-connection/description.md b/apis/export/v1/operations/create-export-connection/description.md similarity index 100% rename from services/export/v1/operations/create-export-connection/description.md rename to apis/export/v1/operations/create-export-connection/description.md diff --git a/services/export/v1/operations/create-export-connection/displayName.md b/apis/export/v1/operations/create-export-connection/displayName.md similarity index 100% rename from services/export/v1/operations/create-export-connection/displayName.md rename to apis/export/v1/operations/create-export-connection/displayName.md diff --git a/services/export/v1/operations/delete-export-connection/description.md b/apis/export/v1/operations/delete-export-connection/description.md similarity index 100% rename from services/export/v1/operations/delete-export-connection/description.md rename to apis/export/v1/operations/delete-export-connection/description.md diff --git a/services/export/v1/operations/delete-export-connection/displayName.md b/apis/export/v1/operations/delete-export-connection/displayName.md similarity index 100% rename from services/export/v1/operations/delete-export-connection/displayName.md rename to apis/export/v1/operations/delete-export-connection/displayName.md diff --git a/services/export/v1/operations/get-authorizationinformation/description.md b/apis/export/v1/operations/get-authorizationinformation/description.md similarity index 100% rename from services/export/v1/operations/get-authorizationinformation/description.md rename to apis/export/v1/operations/get-authorizationinformation/description.md diff --git a/services/export/v1/operations/get-authorizationinformation/displayName.md b/apis/export/v1/operations/get-authorizationinformation/displayName.md similarity index 100% rename from services/export/v1/operations/get-authorizationinformation/displayName.md rename to apis/export/v1/operations/get-authorizationinformation/displayName.md diff --git a/services/export/v1/operations/get-export-connection-run/description.md b/apis/export/v1/operations/get-export-connection-run/description.md similarity index 100% rename from services/export/v1/operations/get-export-connection-run/description.md rename to apis/export/v1/operations/get-export-connection-run/description.md diff --git a/services/export/v1/operations/get-export-connection-run/displayName.md b/apis/export/v1/operations/get-export-connection-run/displayName.md similarity index 100% rename from services/export/v1/operations/get-export-connection-run/displayName.md rename to apis/export/v1/operations/get-export-connection-run/displayName.md diff --git a/services/export/v1/operations/get-export-connection-runs/description.md b/apis/export/v1/operations/get-export-connection-runs/description.md similarity index 100% rename from services/export/v1/operations/get-export-connection-runs/description.md rename to apis/export/v1/operations/get-export-connection-runs/description.md diff --git a/services/export/v1/operations/get-export-connection-runs/displayName.md b/apis/export/v1/operations/get-export-connection-runs/displayName.md similarity index 100% rename from services/export/v1/operations/get-export-connection-runs/displayName.md rename to apis/export/v1/operations/get-export-connection-runs/displayName.md diff --git a/services/export/v1/operations/get-export-connection/description.md b/apis/export/v1/operations/get-export-connection/description.md similarity index 100% rename from services/export/v1/operations/get-export-connection/description.md rename to apis/export/v1/operations/get-export-connection/description.md diff --git a/services/export/v1/operations/get-export-connection/displayName.md b/apis/export/v1/operations/get-export-connection/displayName.md similarity index 100% rename from services/export/v1/operations/get-export-connection/displayName.md rename to apis/export/v1/operations/get-export-connection/displayName.md diff --git a/services/export/v1/operations/get-export-connections/description.md b/apis/export/v1/operations/get-export-connections/description.md similarity index 100% rename from services/export/v1/operations/get-export-connections/description.md rename to apis/export/v1/operations/get-export-connections/description.md diff --git a/services/export/v1/operations/get-export-connections/displayName.md b/apis/export/v1/operations/get-export-connections/displayName.md similarity index 100% rename from services/export/v1/operations/get-export-connections/displayName.md rename to apis/export/v1/operations/get-export-connections/displayName.md diff --git a/services/extensions/v1/description.md b/apis/extensions/v1/description.md similarity index 100% rename from services/extensions/v1/description.md rename to apis/extensions/v1/description.md diff --git a/services/extensions/v1/operations/create-extension-version/description.md b/apis/extensions/v1/operations/create-extension-version/description.md similarity index 100% rename from services/extensions/v1/operations/create-extension-version/description.md rename to apis/extensions/v1/operations/create-extension-version/description.md diff --git a/services/extensions/v1/operations/create-extension-version/displayName.md b/apis/extensions/v1/operations/create-extension-version/displayName.md similarity index 100% rename from services/extensions/v1/operations/create-extension-version/displayName.md rename to apis/extensions/v1/operations/create-extension-version/displayName.md diff --git a/services/extensions/v1/operations/create-private-extension/description.md b/apis/extensions/v1/operations/create-private-extension/description.md similarity index 100% rename from services/extensions/v1/operations/create-private-extension/description.md rename to apis/extensions/v1/operations/create-private-extension/description.md diff --git a/services/extensions/v1/operations/create-private-extension/displayName.md b/apis/extensions/v1/operations/create-private-extension/displayName.md similarity index 100% rename from services/extensions/v1/operations/create-private-extension/displayName.md rename to apis/extensions/v1/operations/create-private-extension/displayName.md diff --git a/services/extensions/v1/operations/create-public-itwin-studio-app/description.md b/apis/extensions/v1/operations/create-public-itwin-studio-app/description.md similarity index 100% rename from services/extensions/v1/operations/create-public-itwin-studio-app/description.md rename to apis/extensions/v1/operations/create-public-itwin-studio-app/description.md diff --git a/services/extensions/v1/operations/create-public-itwin-studio-app/displayName.md b/apis/extensions/v1/operations/create-public-itwin-studio-app/displayName.md similarity index 100% rename from services/extensions/v1/operations/create-public-itwin-studio-app/displayName.md rename to apis/extensions/v1/operations/create-public-itwin-studio-app/displayName.md diff --git a/services/extensions/v1/operations/delete-extension/description.md b/apis/extensions/v1/operations/delete-extension/description.md similarity index 100% rename from services/extensions/v1/operations/delete-extension/description.md rename to apis/extensions/v1/operations/delete-extension/description.md diff --git a/services/extensions/v1/operations/delete-extension/displayName.md b/apis/extensions/v1/operations/delete-extension/displayName.md similarity index 100% rename from services/extensions/v1/operations/delete-extension/displayName.md rename to apis/extensions/v1/operations/delete-extension/displayName.md diff --git a/services/extensions/v1/operations/get-extension-version/description.md b/apis/extensions/v1/operations/get-extension-version/description.md similarity index 100% rename from services/extensions/v1/operations/get-extension-version/description.md rename to apis/extensions/v1/operations/get-extension-version/description.md diff --git a/services/extensions/v1/operations/get-extension-version/displayName.md b/apis/extensions/v1/operations/get-extension-version/displayName.md similarity index 100% rename from services/extensions/v1/operations/get-extension-version/displayName.md rename to apis/extensions/v1/operations/get-extension-version/displayName.md diff --git a/services/extensions/v1/operations/get-extension-versions/description.md b/apis/extensions/v1/operations/get-extension-versions/description.md similarity index 100% rename from services/extensions/v1/operations/get-extension-versions/description.md rename to apis/extensions/v1/operations/get-extension-versions/description.md diff --git a/services/extensions/v1/operations/get-extension-versions/displayName.md b/apis/extensions/v1/operations/get-extension-versions/displayName.md similarity index 100% rename from services/extensions/v1/operations/get-extension-versions/displayName.md rename to apis/extensions/v1/operations/get-extension-versions/displayName.md diff --git a/services/extensions/v1/operations/get-extensions/description.md b/apis/extensions/v1/operations/get-extensions/description.md similarity index 100% rename from services/extensions/v1/operations/get-extensions/description.md rename to apis/extensions/v1/operations/get-extensions/description.md diff --git a/services/extensions/v1/operations/get-extensions/displayName.md b/apis/extensions/v1/operations/get-extensions/displayName.md similarity index 100% rename from services/extensions/v1/operations/get-extensions/displayName.md rename to apis/extensions/v1/operations/get-extensions/displayName.md diff --git a/services/extensions/v1/operations/get-latest-extension-version/description.md b/apis/extensions/v1/operations/get-latest-extension-version/description.md similarity index 100% rename from services/extensions/v1/operations/get-latest-extension-version/description.md rename to apis/extensions/v1/operations/get-latest-extension-version/description.md diff --git a/services/extensions/v1/operations/get-latest-extension-version/displayName.md b/apis/extensions/v1/operations/get-latest-extension-version/displayName.md similarity index 100% rename from services/extensions/v1/operations/get-latest-extension-version/displayName.md rename to apis/extensions/v1/operations/get-latest-extension-version/displayName.md diff --git a/services/extensions/v1/operations/update-extension/description.md b/apis/extensions/v1/operations/update-extension/description.md similarity index 100% rename from services/extensions/v1/operations/update-extension/description.md rename to apis/extensions/v1/operations/update-extension/description.md diff --git a/services/extensions/v1/operations/update-extension/displayName.md b/apis/extensions/v1/operations/update-extension/displayName.md similarity index 100% rename from services/extensions/v1/operations/update-extension/displayName.md rename to apis/extensions/v1/operations/update-extension/displayName.md diff --git a/services/forms/v1/description.md b/apis/forms/v1/description.md similarity index 100% rename from services/forms/v1/description.md rename to apis/forms/v1/description.md diff --git a/services/forms/v1/operations/add-attachment-to-form/description.md b/apis/forms/v1/operations/add-attachment-to-form/description.md similarity index 100% rename from services/forms/v1/operations/add-attachment-to-form/description.md rename to apis/forms/v1/operations/add-attachment-to-form/description.md diff --git a/services/forms/v1/operations/add-attachment-to-form/displayName.md b/apis/forms/v1/operations/add-attachment-to-form/displayName.md similarity index 100% rename from services/forms/v1/operations/add-attachment-to-form/displayName.md rename to apis/forms/v1/operations/add-attachment-to-form/displayName.md diff --git a/services/forms/v1/operations/add-comment-to-form/description.md b/apis/forms/v1/operations/add-comment-to-form/description.md similarity index 100% rename from services/forms/v1/operations/add-comment-to-form/description.md rename to apis/forms/v1/operations/add-comment-to-form/description.md diff --git a/services/forms/v1/operations/add-comment-to-form/displayName.md b/apis/forms/v1/operations/add-comment-to-form/displayName.md similarity index 100% rename from services/forms/v1/operations/add-comment-to-form/displayName.md rename to apis/forms/v1/operations/add-comment-to-form/displayName.md diff --git a/services/forms/v1/operations/create-form-data/description.md b/apis/forms/v1/operations/create-form-data/description.md similarity index 100% rename from services/forms/v1/operations/create-form-data/description.md rename to apis/forms/v1/operations/create-form-data/description.md diff --git a/services/forms/v1/operations/create-form-data/displayName.md b/apis/forms/v1/operations/create-form-data/displayName.md similarity index 100% rename from services/forms/v1/operations/create-form-data/displayName.md rename to apis/forms/v1/operations/create-form-data/displayName.md diff --git a/services/forms/v1/operations/delete-attachment/description.md b/apis/forms/v1/operations/delete-attachment/description.md similarity index 100% rename from services/forms/v1/operations/delete-attachment/description.md rename to apis/forms/v1/operations/delete-attachment/description.md diff --git a/services/forms/v1/operations/delete-attachment/displayName.md b/apis/forms/v1/operations/delete-attachment/displayName.md similarity index 100% rename from services/forms/v1/operations/delete-attachment/displayName.md rename to apis/forms/v1/operations/delete-attachment/displayName.md diff --git a/services/forms/v1/operations/delete-comment/description.md b/apis/forms/v1/operations/delete-comment/description.md similarity index 100% rename from services/forms/v1/operations/delete-comment/description.md rename to apis/forms/v1/operations/delete-comment/description.md diff --git a/services/forms/v1/operations/delete-comment/displayName.md b/apis/forms/v1/operations/delete-comment/displayName.md similarity index 100% rename from services/forms/v1/operations/delete-comment/displayName.md rename to apis/forms/v1/operations/delete-comment/displayName.md diff --git a/services/forms/v1/operations/delete-form-data/description.md b/apis/forms/v1/operations/delete-form-data/description.md similarity index 100% rename from services/forms/v1/operations/delete-form-data/description.md rename to apis/forms/v1/operations/delete-form-data/description.md diff --git a/services/forms/v1/operations/delete-form-data/displayName.md b/apis/forms/v1/operations/delete-form-data/displayName.md similarity index 100% rename from services/forms/v1/operations/delete-form-data/displayName.md rename to apis/forms/v1/operations/delete-form-data/displayName.md diff --git a/services/forms/v1/operations/download-form-as-file/description.md b/apis/forms/v1/operations/download-form-as-file/description.md similarity index 100% rename from services/forms/v1/operations/download-form-as-file/description.md rename to apis/forms/v1/operations/download-form-as-file/description.md diff --git a/services/forms/v1/operations/download-form-as-file/displayName.md b/apis/forms/v1/operations/download-form-as-file/displayName.md similarity index 100% rename from services/forms/v1/operations/download-form-as-file/displayName.md rename to apis/forms/v1/operations/download-form-as-file/displayName.md diff --git a/services/forms/v1/operations/export-form-to-storage/description.md b/apis/forms/v1/operations/export-form-to-storage/description.md similarity index 100% rename from services/forms/v1/operations/export-form-to-storage/description.md rename to apis/forms/v1/operations/export-form-to-storage/description.md diff --git a/services/forms/v1/operations/export-form-to-storage/displayName.md b/apis/forms/v1/operations/export-form-to-storage/displayName.md similarity index 100% rename from services/forms/v1/operations/export-form-to-storage/displayName.md rename to apis/forms/v1/operations/export-form-to-storage/displayName.md diff --git a/services/forms/v1/operations/get-attachment-file-by-id/description.md b/apis/forms/v1/operations/get-attachment-file-by-id/description.md similarity index 100% rename from services/forms/v1/operations/get-attachment-file-by-id/description.md rename to apis/forms/v1/operations/get-attachment-file-by-id/description.md diff --git a/services/forms/v1/operations/get-attachment-file-by-id/displayName.md b/apis/forms/v1/operations/get-attachment-file-by-id/displayName.md similarity index 100% rename from services/forms/v1/operations/get-attachment-file-by-id/displayName.md rename to apis/forms/v1/operations/get-attachment-file-by-id/displayName.md diff --git a/services/forms/v1/operations/get-audit-trail-for-form-data/description.md b/apis/forms/v1/operations/get-audit-trail-for-form-data/description.md similarity index 100% rename from services/forms/v1/operations/get-audit-trail-for-form-data/description.md rename to apis/forms/v1/operations/get-audit-trail-for-form-data/description.md diff --git a/services/forms/v1/operations/get-audit-trail-for-form-data/displayName.md b/apis/forms/v1/operations/get-audit-trail-for-form-data/displayName.md similarity index 100% rename from services/forms/v1/operations/get-audit-trail-for-form-data/displayName.md rename to apis/forms/v1/operations/get-audit-trail-for-form-data/displayName.md diff --git a/services/forms/v1/operations/get-form-data-attachments/description.md b/apis/forms/v1/operations/get-form-data-attachments/description.md similarity index 100% rename from services/forms/v1/operations/get-form-data-attachments/description.md rename to apis/forms/v1/operations/get-form-data-attachments/description.md diff --git a/services/forms/v1/operations/get-form-data-attachments/displayName.md b/apis/forms/v1/operations/get-form-data-attachments/displayName.md similarity index 100% rename from services/forms/v1/operations/get-form-data-attachments/displayName.md rename to apis/forms/v1/operations/get-form-data-attachments/displayName.md diff --git a/services/forms/v1/operations/get-form-data-comments/description.md b/apis/forms/v1/operations/get-form-data-comments/description.md similarity index 100% rename from services/forms/v1/operations/get-form-data-comments/description.md rename to apis/forms/v1/operations/get-form-data-comments/description.md diff --git a/services/forms/v1/operations/get-form-data-comments/displayName.md b/apis/forms/v1/operations/get-form-data-comments/displayName.md similarity index 100% rename from services/forms/v1/operations/get-form-data-comments/displayName.md rename to apis/forms/v1/operations/get-form-data-comments/displayName.md diff --git a/services/forms/v1/operations/get-form-data-details/description.md b/apis/forms/v1/operations/get-form-data-details/description.md similarity index 100% rename from services/forms/v1/operations/get-form-data-details/description.md rename to apis/forms/v1/operations/get-form-data-details/description.md diff --git a/services/forms/v1/operations/get-form-data-details/displayName.md b/apis/forms/v1/operations/get-form-data-details/displayName.md similarity index 100% rename from services/forms/v1/operations/get-form-data-details/displayName.md rename to apis/forms/v1/operations/get-form-data-details/displayName.md diff --git a/services/forms/v1/operations/get-form-definition-by-id/description.md b/apis/forms/v1/operations/get-form-definition-by-id/description.md similarity index 100% rename from services/forms/v1/operations/get-form-definition-by-id/description.md rename to apis/forms/v1/operations/get-form-definition-by-id/description.md diff --git a/services/forms/v1/operations/get-form-definition-by-id/displayName.md b/apis/forms/v1/operations/get-form-definition-by-id/displayName.md similarity index 100% rename from services/forms/v1/operations/get-form-definition-by-id/displayName.md rename to apis/forms/v1/operations/get-form-definition-by-id/displayName.md diff --git a/services/forms/v1/operations/get-list-group/description.md b/apis/forms/v1/operations/get-list-group/description.md similarity index 100% rename from services/forms/v1/operations/get-list-group/description.md rename to apis/forms/v1/operations/get-list-group/description.md diff --git a/services/forms/v1/operations/get-list-group/displayName.md b/apis/forms/v1/operations/get-list-group/displayName.md similarity index 100% rename from services/forms/v1/operations/get-list-group/displayName.md rename to apis/forms/v1/operations/get-list-group/displayName.md diff --git a/services/forms/v1/operations/get-project-form-data/description.md b/apis/forms/v1/operations/get-project-form-data/description.md similarity index 100% rename from services/forms/v1/operations/get-project-form-data/description.md rename to apis/forms/v1/operations/get-project-form-data/description.md diff --git a/services/forms/v1/operations/get-project-form-data/displayName.md b/apis/forms/v1/operations/get-project-form-data/displayName.md similarity index 100% rename from services/forms/v1/operations/get-project-form-data/displayName.md rename to apis/forms/v1/operations/get-project-form-data/displayName.md diff --git a/services/forms/v1/operations/get-project-form-definitions/description.md b/apis/forms/v1/operations/get-project-form-definitions/description.md similarity index 100% rename from services/forms/v1/operations/get-project-form-definitions/description.md rename to apis/forms/v1/operations/get-project-form-definitions/description.md diff --git a/services/forms/v1/operations/get-project-form-definitions/displayName.md b/apis/forms/v1/operations/get-project-form-definitions/displayName.md similarity index 100% rename from services/forms/v1/operations/get-project-form-definitions/displayName.md rename to apis/forms/v1/operations/get-project-form-definitions/displayName.md diff --git a/services/forms/v1/operations/get-static-image/description.md b/apis/forms/v1/operations/get-static-image/description.md similarity index 100% rename from services/forms/v1/operations/get-static-image/description.md rename to apis/forms/v1/operations/get-static-image/description.md diff --git a/services/forms/v1/operations/get-static-image/displayName.md b/apis/forms/v1/operations/get-static-image/displayName.md similarity index 100% rename from services/forms/v1/operations/get-static-image/displayName.md rename to apis/forms/v1/operations/get-static-image/displayName.md diff --git a/services/forms/v1/operations/get-workflow/description.md b/apis/forms/v1/operations/get-workflow/description.md similarity index 100% rename from services/forms/v1/operations/get-workflow/description.md rename to apis/forms/v1/operations/get-workflow/description.md diff --git a/services/forms/v1/operations/get-workflow/displayName.md b/apis/forms/v1/operations/get-workflow/displayName.md similarity index 100% rename from services/forms/v1/operations/get-workflow/displayName.md rename to apis/forms/v1/operations/get-workflow/displayName.md diff --git a/services/forms/v1/operations/update-form-data/description.md b/apis/forms/v1/operations/update-form-data/description.md similarity index 100% rename from services/forms/v1/operations/update-form-data/description.md rename to apis/forms/v1/operations/update-form-data/description.md diff --git a/services/forms/v1/operations/update-form-data/displayName.md b/apis/forms/v1/operations/update-form-data/displayName.md similarity index 100% rename from services/forms/v1/operations/update-form-data/displayName.md rename to apis/forms/v1/operations/update-form-data/displayName.md diff --git a/services/forms/v1/operations/upload-attachment-file/description.md b/apis/forms/v1/operations/upload-attachment-file/description.md similarity index 100% rename from services/forms/v1/operations/upload-attachment-file/description.md rename to apis/forms/v1/operations/upload-attachment-file/description.md diff --git a/services/forms/v1/operations/upload-attachment-file/displayName.md b/apis/forms/v1/operations/upload-attachment-file/displayName.md similarity index 100% rename from services/forms/v1/operations/upload-attachment-file/displayName.md rename to apis/forms/v1/operations/upload-attachment-file/displayName.md diff --git a/services/grouping-and-mapping/v1/description.md b/apis/grouping-and-mapping/v1/description.md similarity index 100% rename from services/grouping-and-mapping/v1/description.md rename to apis/grouping-and-mapping/v1/description.md diff --git a/services/grouping-and-mapping/v1/operations/create-group/description.md b/apis/grouping-and-mapping/v1/operations/create-group/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/create-group/description.md rename to apis/grouping-and-mapping/v1/operations/create-group/description.md diff --git a/services/grouping-and-mapping/v1/operations/create-group/displayName.md b/apis/grouping-and-mapping/v1/operations/create-group/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/create-group/displayName.md rename to apis/grouping-and-mapping/v1/operations/create-group/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/create-mapping/description.md b/apis/grouping-and-mapping/v1/operations/create-mapping/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/create-mapping/description.md rename to apis/grouping-and-mapping/v1/operations/create-mapping/description.md diff --git a/services/grouping-and-mapping/v1/operations/create-mapping/displayName.md b/apis/grouping-and-mapping/v1/operations/create-mapping/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/create-mapping/displayName.md rename to apis/grouping-and-mapping/v1/operations/create-mapping/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/create-property/description.md b/apis/grouping-and-mapping/v1/operations/create-property/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/create-property/description.md rename to apis/grouping-and-mapping/v1/operations/create-property/description.md diff --git a/services/grouping-and-mapping/v1/operations/create-property/displayName.md b/apis/grouping-and-mapping/v1/operations/create-property/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/create-property/displayName.md rename to apis/grouping-and-mapping/v1/operations/create-property/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/delete-group/description.md b/apis/grouping-and-mapping/v1/operations/delete-group/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/delete-group/description.md rename to apis/grouping-and-mapping/v1/operations/delete-group/description.md diff --git a/services/grouping-and-mapping/v1/operations/delete-group/displayName.md b/apis/grouping-and-mapping/v1/operations/delete-group/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/delete-group/displayName.md rename to apis/grouping-and-mapping/v1/operations/delete-group/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/delete-mapping/description.md b/apis/grouping-and-mapping/v1/operations/delete-mapping/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/delete-mapping/description.md rename to apis/grouping-and-mapping/v1/operations/delete-mapping/description.md diff --git a/services/grouping-and-mapping/v1/operations/delete-mapping/displayName.md b/apis/grouping-and-mapping/v1/operations/delete-mapping/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/delete-mapping/displayName.md rename to apis/grouping-and-mapping/v1/operations/delete-mapping/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/delete-property/description.md b/apis/grouping-and-mapping/v1/operations/delete-property/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/delete-property/description.md rename to apis/grouping-and-mapping/v1/operations/delete-property/description.md diff --git a/services/grouping-and-mapping/v1/operations/delete-property/displayName.md b/apis/grouping-and-mapping/v1/operations/delete-property/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/delete-property/displayName.md rename to apis/grouping-and-mapping/v1/operations/delete-property/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-audittrail-imodel/description.md b/apis/grouping-and-mapping/v1/operations/get-audittrail-imodel/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-audittrail-imodel/description.md rename to apis/grouping-and-mapping/v1/operations/get-audittrail-imodel/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-audittrail-imodel/displayName.md b/apis/grouping-and-mapping/v1/operations/get-audittrail-imodel/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-audittrail-imodel/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-audittrail-imodel/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-cdm-partition/description.md b/apis/grouping-and-mapping/v1/operations/get-cdm-partition/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-cdm-partition/description.md rename to apis/grouping-and-mapping/v1/operations/get-cdm-partition/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-cdm-partition/displayName.md b/apis/grouping-and-mapping/v1/operations/get-cdm-partition/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-cdm-partition/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-cdm-partition/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-cdm/description.md b/apis/grouping-and-mapping/v1/operations/get-cdm/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-cdm/description.md rename to apis/grouping-and-mapping/v1/operations/get-cdm/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-cdm/displayName.md b/apis/grouping-and-mapping/v1/operations/get-cdm/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-cdm/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-cdm/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-extraction-logs/description.md b/apis/grouping-and-mapping/v1/operations/get-extraction-logs/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-extraction-logs/description.md rename to apis/grouping-and-mapping/v1/operations/get-extraction-logs/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-extraction-logs/displayName.md b/apis/grouping-and-mapping/v1/operations/get-extraction-logs/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-extraction-logs/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-extraction-logs/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-extraction-status/description.md b/apis/grouping-and-mapping/v1/operations/get-extraction-status/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-extraction-status/description.md rename to apis/grouping-and-mapping/v1/operations/get-extraction-status/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-extraction-status/displayName.md b/apis/grouping-and-mapping/v1/operations/get-extraction-status/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-extraction-status/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-extraction-status/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-group/description.md b/apis/grouping-and-mapping/v1/operations/get-group/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-group/description.md rename to apis/grouping-and-mapping/v1/operations/get-group/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-group/displayName.md b/apis/grouping-and-mapping/v1/operations/get-group/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-group/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-group/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-groups/description.md b/apis/grouping-and-mapping/v1/operations/get-groups/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-groups/description.md rename to apis/grouping-and-mapping/v1/operations/get-groups/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-groups/displayName.md b/apis/grouping-and-mapping/v1/operations/get-groups/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-groups/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-groups/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-imodel-extractions/description.md b/apis/grouping-and-mapping/v1/operations/get-imodel-extractions/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-imodel-extractions/description.md rename to apis/grouping-and-mapping/v1/operations/get-imodel-extractions/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-imodel-extractions/displayName.md b/apis/grouping-and-mapping/v1/operations/get-imodel-extractions/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-imodel-extractions/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-imodel-extractions/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-mapping-extractions/description.md b/apis/grouping-and-mapping/v1/operations/get-mapping-extractions/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-mapping-extractions/description.md rename to apis/grouping-and-mapping/v1/operations/get-mapping-extractions/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-mapping-extractions/displayName.md b/apis/grouping-and-mapping/v1/operations/get-mapping-extractions/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-mapping-extractions/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-mapping-extractions/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-mapping/description.md b/apis/grouping-and-mapping/v1/operations/get-mapping/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-mapping/description.md rename to apis/grouping-and-mapping/v1/operations/get-mapping/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-mapping/displayName.md b/apis/grouping-and-mapping/v1/operations/get-mapping/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-mapping/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-mapping/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-mappings/description.md b/apis/grouping-and-mapping/v1/operations/get-mappings/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-mappings/description.md rename to apis/grouping-and-mapping/v1/operations/get-mappings/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-mappings/displayName.md b/apis/grouping-and-mapping/v1/operations/get-mappings/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-mappings/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-mappings/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-properties/description.md b/apis/grouping-and-mapping/v1/operations/get-properties/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-properties/description.md rename to apis/grouping-and-mapping/v1/operations/get-properties/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-properties/displayName.md b/apis/grouping-and-mapping/v1/operations/get-properties/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-properties/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-properties/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/get-property/description.md b/apis/grouping-and-mapping/v1/operations/get-property/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-property/description.md rename to apis/grouping-and-mapping/v1/operations/get-property/description.md diff --git a/services/grouping-and-mapping/v1/operations/get-property/displayName.md b/apis/grouping-and-mapping/v1/operations/get-property/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/get-property/displayName.md rename to apis/grouping-and-mapping/v1/operations/get-property/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/run-extraction/description.md b/apis/grouping-and-mapping/v1/operations/run-extraction/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/run-extraction/description.md rename to apis/grouping-and-mapping/v1/operations/run-extraction/description.md diff --git a/services/grouping-and-mapping/v1/operations/run-extraction/displayName.md b/apis/grouping-and-mapping/v1/operations/run-extraction/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/run-extraction/displayName.md rename to apis/grouping-and-mapping/v1/operations/run-extraction/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/update-group/description.md b/apis/grouping-and-mapping/v1/operations/update-group/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/update-group/description.md rename to apis/grouping-and-mapping/v1/operations/update-group/description.md diff --git a/services/grouping-and-mapping/v1/operations/update-group/displayName.md b/apis/grouping-and-mapping/v1/operations/update-group/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/update-group/displayName.md rename to apis/grouping-and-mapping/v1/operations/update-group/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/update-mapping/description.md b/apis/grouping-and-mapping/v1/operations/update-mapping/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/update-mapping/description.md rename to apis/grouping-and-mapping/v1/operations/update-mapping/description.md diff --git a/services/grouping-and-mapping/v1/operations/update-mapping/displayName.md b/apis/grouping-and-mapping/v1/operations/update-mapping/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/update-mapping/displayName.md rename to apis/grouping-and-mapping/v1/operations/update-mapping/displayName.md diff --git a/services/grouping-and-mapping/v1/operations/update-property/description.md b/apis/grouping-and-mapping/v1/operations/update-property/description.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/update-property/description.md rename to apis/grouping-and-mapping/v1/operations/update-property/description.md diff --git a/services/grouping-and-mapping/v1/operations/update-property/displayName.md b/apis/grouping-and-mapping/v1/operations/update-property/displayName.md similarity index 100% rename from services/grouping-and-mapping/v1/operations/update-property/displayName.md rename to apis/grouping-and-mapping/v1/operations/update-property/displayName.md diff --git a/services/imodel-rpc/v1/operations/rpc-version-get/description.md b/apis/imodel-rpc/v1/operations/rpc-version-get/description.md similarity index 100% rename from services/imodel-rpc/v1/operations/rpc-version-get/description.md rename to apis/imodel-rpc/v1/operations/rpc-version-get/description.md diff --git a/services/imodel-rpc/v1/operations/rpc-version-get/displayName.md b/apis/imodel-rpc/v1/operations/rpc-version-get/displayName.md similarity index 100% rename from services/imodel-rpc/v1/operations/rpc-version-get/displayName.md rename to apis/imodel-rpc/v1/operations/rpc-version-get/displayName.md diff --git a/services/imodel-rpc/v1/operations/rpc-version/description.md b/apis/imodel-rpc/v1/operations/rpc-version/description.md similarity index 100% rename from services/imodel-rpc/v1/operations/rpc-version/description.md rename to apis/imodel-rpc/v1/operations/rpc-version/description.md diff --git a/services/imodel-rpc/v1/operations/rpc-version/displayName.md b/apis/imodel-rpc/v1/operations/rpc-version/displayName.md similarity index 100% rename from services/imodel-rpc/v1/operations/rpc-version/displayName.md rename to apis/imodel-rpc/v1/operations/rpc-version/displayName.md diff --git a/services/imodels-odata/v1/description.md b/apis/imodels-odata/v1/description.md similarity index 100% rename from services/imodels-odata/v1/description.md rename to apis/imodels-odata/v1/description.md diff --git a/services/imodels-odata/v1/operations/mapping-odata-entity/description.md b/apis/imodels-odata/v1/operations/mapping-odata-entity/description.md similarity index 100% rename from services/imodels-odata/v1/operations/mapping-odata-entity/description.md rename to apis/imodels-odata/v1/operations/mapping-odata-entity/description.md diff --git a/services/imodels-odata/v1/operations/mapping-odata-entity/displayName.md b/apis/imodels-odata/v1/operations/mapping-odata-entity/displayName.md similarity index 100% rename from services/imodels-odata/v1/operations/mapping-odata-entity/displayName.md rename to apis/imodels-odata/v1/operations/mapping-odata-entity/displayName.md diff --git a/services/imodels-odata/v1/operations/mapping-odata-metadata/description.md b/apis/imodels-odata/v1/operations/mapping-odata-metadata/description.md similarity index 100% rename from services/imodels-odata/v1/operations/mapping-odata-metadata/description.md rename to apis/imodels-odata/v1/operations/mapping-odata-metadata/description.md diff --git a/services/imodels-odata/v1/operations/mapping-odata-metadata/displayName.md b/apis/imodels-odata/v1/operations/mapping-odata-metadata/displayName.md similarity index 100% rename from services/imodels-odata/v1/operations/mapping-odata-metadata/displayName.md rename to apis/imodels-odata/v1/operations/mapping-odata-metadata/displayName.md diff --git a/services/imodels-odata/v1/operations/mapping-odata/description.md b/apis/imodels-odata/v1/operations/mapping-odata/description.md similarity index 100% rename from services/imodels-odata/v1/operations/mapping-odata/description.md rename to apis/imodels-odata/v1/operations/mapping-odata/description.md diff --git a/services/imodels-odata/v1/operations/mapping-odata/displayName.md b/apis/imodels-odata/v1/operations/mapping-odata/displayName.md similarity index 100% rename from services/imodels-odata/v1/operations/mapping-odata/displayName.md rename to apis/imodels-odata/v1/operations/mapping-odata/displayName.md diff --git a/services/imodels/v2/description.md b/apis/imodels/v2/description.md similarity index 100% rename from services/imodels/v2/description.md rename to apis/imodels/v2/description.md diff --git a/services/imodels/v2/operations/acquire-imodel-briefcase/description.md b/apis/imodels/v2/operations/acquire-imodel-briefcase/description.md similarity index 100% rename from services/imodels/v2/operations/acquire-imodel-briefcase/description.md rename to apis/imodels/v2/operations/acquire-imodel-briefcase/description.md diff --git a/services/imodels/v2/operations/acquire-imodel-briefcase/displayName.md b/apis/imodels/v2/operations/acquire-imodel-briefcase/displayName.md similarity index 100% rename from services/imodels/v2/operations/acquire-imodel-briefcase/displayName.md rename to apis/imodels/v2/operations/acquire-imodel-briefcase/displayName.md diff --git a/services/imodels/v2/operations/clone-imodel/description.md b/apis/imodels/v2/operations/clone-imodel/description.md similarity index 100% rename from services/imodels/v2/operations/clone-imodel/description.md rename to apis/imodels/v2/operations/clone-imodel/description.md diff --git a/services/imodels/v2/operations/clone-imodel/displayName.md b/apis/imodels/v2/operations/clone-imodel/displayName.md similarity index 100% rename from services/imodels/v2/operations/clone-imodel/displayName.md rename to apis/imodels/v2/operations/clone-imodel/displayName.md diff --git a/services/imodels/v2/operations/complete-imodel-baseline-file-upload/description.md b/apis/imodels/v2/operations/complete-imodel-baseline-file-upload/description.md similarity index 100% rename from services/imodels/v2/operations/complete-imodel-baseline-file-upload/description.md rename to apis/imodels/v2/operations/complete-imodel-baseline-file-upload/description.md diff --git a/services/imodels/v2/operations/complete-imodel-baseline-file-upload/displayName.md b/apis/imodels/v2/operations/complete-imodel-baseline-file-upload/displayName.md similarity index 100% rename from services/imodels/v2/operations/complete-imodel-baseline-file-upload/displayName.md rename to apis/imodels/v2/operations/complete-imodel-baseline-file-upload/displayName.md diff --git a/services/imodels/v2/operations/create-imodel-changeset-extended-data/description.md b/apis/imodels/v2/operations/create-imodel-changeset-extended-data/description.md similarity index 100% rename from services/imodels/v2/operations/create-imodel-changeset-extended-data/description.md rename to apis/imodels/v2/operations/create-imodel-changeset-extended-data/description.md diff --git a/services/imodels/v2/operations/create-imodel-changeset-extended-data/displayName.md b/apis/imodels/v2/operations/create-imodel-changeset-extended-data/displayName.md similarity index 100% rename from services/imodels/v2/operations/create-imodel-changeset-extended-data/displayName.md rename to apis/imodels/v2/operations/create-imodel-changeset-extended-data/displayName.md diff --git a/services/imodels/v2/operations/create-imodel-changeset-group/description.md b/apis/imodels/v2/operations/create-imodel-changeset-group/description.md similarity index 100% rename from services/imodels/v2/operations/create-imodel-changeset-group/description.md rename to apis/imodels/v2/operations/create-imodel-changeset-group/description.md diff --git a/services/imodels/v2/operations/create-imodel-changeset-group/displayName.md b/apis/imodels/v2/operations/create-imodel-changeset-group/displayName.md similarity index 100% rename from services/imodels/v2/operations/create-imodel-changeset-group/displayName.md rename to apis/imodels/v2/operations/create-imodel-changeset-group/displayName.md diff --git a/services/imodels/v2/operations/create-imodel-changeset/description.md b/apis/imodels/v2/operations/create-imodel-changeset/description.md similarity index 100% rename from services/imodels/v2/operations/create-imodel-changeset/description.md rename to apis/imodels/v2/operations/create-imodel-changeset/description.md diff --git a/services/imodels/v2/operations/create-imodel-changeset/displayName.md b/apis/imodels/v2/operations/create-imodel-changeset/displayName.md similarity index 100% rename from services/imodels/v2/operations/create-imodel-changeset/displayName.md rename to apis/imodels/v2/operations/create-imodel-changeset/displayName.md diff --git a/services/imodels/v2/operations/create-imodel-named-version/description.md b/apis/imodels/v2/operations/create-imodel-named-version/description.md similarity index 100% rename from services/imodels/v2/operations/create-imodel-named-version/description.md rename to apis/imodels/v2/operations/create-imodel-named-version/description.md diff --git a/services/imodels/v2/operations/create-imodel-named-version/displayName.md b/apis/imodels/v2/operations/create-imodel-named-version/displayName.md similarity index 100% rename from services/imodels/v2/operations/create-imodel-named-version/displayName.md rename to apis/imodels/v2/operations/create-imodel-named-version/displayName.md diff --git a/services/imodels/v2/operations/create-imodel-share/description.md b/apis/imodels/v2/operations/create-imodel-share/description.md similarity index 100% rename from services/imodels/v2/operations/create-imodel-share/description.md rename to apis/imodels/v2/operations/create-imodel-share/description.md diff --git a/services/imodels/v2/operations/create-imodel-share/displayName.md b/apis/imodels/v2/operations/create-imodel-share/displayName.md similarity index 100% rename from services/imodels/v2/operations/create-imodel-share/displayName.md rename to apis/imodels/v2/operations/create-imodel-share/displayName.md diff --git a/services/imodels/v2/operations/create-imodel/description.md b/apis/imodels/v2/operations/create-imodel/description.md similarity index 100% rename from services/imodels/v2/operations/create-imodel/description.md rename to apis/imodels/v2/operations/create-imodel/description.md diff --git a/services/imodels/v2/operations/create-imodel/displayName.md b/apis/imodels/v2/operations/create-imodel/displayName.md similarity index 100% rename from services/imodels/v2/operations/create-imodel/displayName.md rename to apis/imodels/v2/operations/create-imodel/displayName.md diff --git a/services/imodels/v2/operations/delete-imodel/description.md b/apis/imodels/v2/operations/delete-imodel/description.md similarity index 100% rename from services/imodels/v2/operations/delete-imodel/description.md rename to apis/imodels/v2/operations/delete-imodel/description.md diff --git a/services/imodels/v2/operations/delete-imodel/displayName.md b/apis/imodels/v2/operations/delete-imodel/displayName.md similarity index 100% rename from services/imodels/v2/operations/delete-imodel/displayName.md rename to apis/imodels/v2/operations/delete-imodel/displayName.md diff --git a/services/imodels/v2/operations/fork-imodel/description.md b/apis/imodels/v2/operations/fork-imodel/description.md similarity index 100% rename from services/imodels/v2/operations/fork-imodel/description.md rename to apis/imodels/v2/operations/fork-imodel/description.md diff --git a/services/imodels/v2/operations/fork-imodel/displayName.md b/apis/imodels/v2/operations/fork-imodel/displayName.md similarity index 100% rename from services/imodels/v2/operations/fork-imodel/displayName.md rename to apis/imodels/v2/operations/fork-imodel/displayName.md diff --git a/services/imodels/v2/operations/get-briefcase-checkpoint/description.md b/apis/imodels/v2/operations/get-briefcase-checkpoint/description.md similarity index 100% rename from services/imodels/v2/operations/get-briefcase-checkpoint/description.md rename to apis/imodels/v2/operations/get-briefcase-checkpoint/description.md diff --git a/services/imodels/v2/operations/get-briefcase-checkpoint/displayName.md b/apis/imodels/v2/operations/get-briefcase-checkpoint/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-briefcase-checkpoint/displayName.md rename to apis/imodels/v2/operations/get-briefcase-checkpoint/displayName.md diff --git a/services/imodels/v2/operations/get-changeset-checkpoint/description.md b/apis/imodels/v2/operations/get-changeset-checkpoint/description.md similarity index 100% rename from services/imodels/v2/operations/get-changeset-checkpoint/description.md rename to apis/imodels/v2/operations/get-changeset-checkpoint/description.md diff --git a/services/imodels/v2/operations/get-changeset-checkpoint/displayName.md b/apis/imodels/v2/operations/get-changeset-checkpoint/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-changeset-checkpoint/displayName.md rename to apis/imodels/v2/operations/get-changeset-checkpoint/displayName.md diff --git a/services/imodels/v2/operations/get-create-imodel-operation-details/description.md b/apis/imodels/v2/operations/get-create-imodel-operation-details/description.md similarity index 100% rename from services/imodels/v2/operations/get-create-imodel-operation-details/description.md rename to apis/imodels/v2/operations/get-create-imodel-operation-details/description.md diff --git a/services/imodels/v2/operations/get-create-imodel-operation-details/displayName.md b/apis/imodels/v2/operations/get-create-imodel-operation-details/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-create-imodel-operation-details/displayName.md rename to apis/imodels/v2/operations/get-create-imodel-operation-details/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-baseline-file-details/description.md b/apis/imodels/v2/operations/get-imodel-baseline-file-details/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-baseline-file-details/description.md rename to apis/imodels/v2/operations/get-imodel-baseline-file-details/description.md diff --git a/services/imodels/v2/operations/get-imodel-baseline-file-details/displayName.md b/apis/imodels/v2/operations/get-imodel-baseline-file-details/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-baseline-file-details/displayName.md rename to apis/imodels/v2/operations/get-imodel-baseline-file-details/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-briefcase-details/description.md b/apis/imodels/v2/operations/get-imodel-briefcase-details/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-briefcase-details/description.md rename to apis/imodels/v2/operations/get-imodel-briefcase-details/description.md diff --git a/services/imodels/v2/operations/get-imodel-briefcase-details/displayName.md b/apis/imodels/v2/operations/get-imodel-briefcase-details/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-briefcase-details/displayName.md rename to apis/imodels/v2/operations/get-imodel-briefcase-details/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-briefcases/description.md b/apis/imodels/v2/operations/get-imodel-briefcases/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-briefcases/description.md rename to apis/imodels/v2/operations/get-imodel-briefcases/description.md diff --git a/services/imodels/v2/operations/get-imodel-briefcases/displayName.md b/apis/imodels/v2/operations/get-imodel-briefcases/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-briefcases/displayName.md rename to apis/imodels/v2/operations/get-imodel-briefcases/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-changeset-details/description.md b/apis/imodels/v2/operations/get-imodel-changeset-details/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changeset-details/description.md rename to apis/imodels/v2/operations/get-imodel-changeset-details/description.md diff --git a/services/imodels/v2/operations/get-imodel-changeset-details/displayName.md b/apis/imodels/v2/operations/get-imodel-changeset-details/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changeset-details/displayName.md rename to apis/imodels/v2/operations/get-imodel-changeset-details/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-changeset-extended-data-details/description.md b/apis/imodels/v2/operations/get-imodel-changeset-extended-data-details/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changeset-extended-data-details/description.md rename to apis/imodels/v2/operations/get-imodel-changeset-extended-data-details/description.md diff --git a/services/imodels/v2/operations/get-imodel-changeset-extended-data-details/displayName.md b/apis/imodels/v2/operations/get-imodel-changeset-extended-data-details/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changeset-extended-data-details/displayName.md rename to apis/imodels/v2/operations/get-imodel-changeset-extended-data-details/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-changeset-group-details/description.md b/apis/imodels/v2/operations/get-imodel-changeset-group-details/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changeset-group-details/description.md rename to apis/imodels/v2/operations/get-imodel-changeset-group-details/description.md diff --git a/services/imodels/v2/operations/get-imodel-changeset-group-details/displayName.md b/apis/imodels/v2/operations/get-imodel-changeset-group-details/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changeset-group-details/displayName.md rename to apis/imodels/v2/operations/get-imodel-changeset-group-details/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-changeset-groups/description.md b/apis/imodels/v2/operations/get-imodel-changeset-groups/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changeset-groups/description.md rename to apis/imodels/v2/operations/get-imodel-changeset-groups/description.md diff --git a/services/imodels/v2/operations/get-imodel-changeset-groups/displayName.md b/apis/imodels/v2/operations/get-imodel-changeset-groups/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changeset-groups/displayName.md rename to apis/imodels/v2/operations/get-imodel-changeset-groups/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-changesets-extended-data/description.md b/apis/imodels/v2/operations/get-imodel-changesets-extended-data/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changesets-extended-data/description.md rename to apis/imodels/v2/operations/get-imodel-changesets-extended-data/description.md diff --git a/services/imodels/v2/operations/get-imodel-changesets-extended-data/displayName.md b/apis/imodels/v2/operations/get-imodel-changesets-extended-data/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changesets-extended-data/displayName.md rename to apis/imodels/v2/operations/get-imodel-changesets-extended-data/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-changesets/description.md b/apis/imodels/v2/operations/get-imodel-changesets/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changesets/description.md rename to apis/imodels/v2/operations/get-imodel-changesets/description.md diff --git a/services/imodels/v2/operations/get-imodel-changesets/displayName.md b/apis/imodels/v2/operations/get-imodel-changesets/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-changesets/displayName.md rename to apis/imodels/v2/operations/get-imodel-changesets/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-details/description.md b/apis/imodels/v2/operations/get-imodel-details/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-details/description.md rename to apis/imodels/v2/operations/get-imodel-details/description.md diff --git a/services/imodels/v2/operations/get-imodel-details/displayName.md b/apis/imodels/v2/operations/get-imodel-details/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-details/displayName.md rename to apis/imodels/v2/operations/get-imodel-details/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-locks/description.md b/apis/imodels/v2/operations/get-imodel-locks/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-locks/description.md rename to apis/imodels/v2/operations/get-imodel-locks/description.md diff --git a/services/imodels/v2/operations/get-imodel-locks/displayName.md b/apis/imodels/v2/operations/get-imodel-locks/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-locks/displayName.md rename to apis/imodels/v2/operations/get-imodel-locks/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-named-version-details/description.md b/apis/imodels/v2/operations/get-imodel-named-version-details/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-named-version-details/description.md rename to apis/imodels/v2/operations/get-imodel-named-version-details/description.md diff --git a/services/imodels/v2/operations/get-imodel-named-version-details/displayName.md b/apis/imodels/v2/operations/get-imodel-named-version-details/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-named-version-details/displayName.md rename to apis/imodels/v2/operations/get-imodel-named-version-details/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-named-versions/description.md b/apis/imodels/v2/operations/get-imodel-named-versions/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-named-versions/description.md rename to apis/imodels/v2/operations/get-imodel-named-versions/description.md diff --git a/services/imodels/v2/operations/get-imodel-named-versions/displayName.md b/apis/imodels/v2/operations/get-imodel-named-versions/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-named-versions/displayName.md rename to apis/imodels/v2/operations/get-imodel-named-versions/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-permissions/description.md b/apis/imodels/v2/operations/get-imodel-permissions/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-permissions/description.md rename to apis/imodels/v2/operations/get-imodel-permissions/description.md diff --git a/services/imodels/v2/operations/get-imodel-permissions/displayName.md b/apis/imodels/v2/operations/get-imodel-permissions/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-permissions/displayName.md rename to apis/imodels/v2/operations/get-imodel-permissions/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-role-permissions/description.md b/apis/imodels/v2/operations/get-imodel-role-permissions/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-role-permissions/description.md rename to apis/imodels/v2/operations/get-imodel-role-permissions/description.md diff --git a/services/imodels/v2/operations/get-imodel-role-permissions/displayName.md b/apis/imodels/v2/operations/get-imodel-role-permissions/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-role-permissions/displayName.md rename to apis/imodels/v2/operations/get-imodel-role-permissions/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-share/description.md b/apis/imodels/v2/operations/get-imodel-share/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-share/description.md rename to apis/imodels/v2/operations/get-imodel-share/description.md diff --git a/services/imodels/v2/operations/get-imodel-share/displayName.md b/apis/imodels/v2/operations/get-imodel-share/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-share/displayName.md rename to apis/imodels/v2/operations/get-imodel-share/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-shares/description.md b/apis/imodels/v2/operations/get-imodel-shares/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-shares/description.md rename to apis/imodels/v2/operations/get-imodel-shares/description.md diff --git a/services/imodels/v2/operations/get-imodel-shares/displayName.md b/apis/imodels/v2/operations/get-imodel-shares/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-shares/displayName.md rename to apis/imodels/v2/operations/get-imodel-shares/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-thumbnail/description.md b/apis/imodels/v2/operations/get-imodel-thumbnail/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-thumbnail/description.md rename to apis/imodels/v2/operations/get-imodel-thumbnail/description.md diff --git a/services/imodels/v2/operations/get-imodel-thumbnail/displayName.md b/apis/imodels/v2/operations/get-imodel-thumbnail/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-thumbnail/displayName.md rename to apis/imodels/v2/operations/get-imodel-thumbnail/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-user-details/description.md b/apis/imodels/v2/operations/get-imodel-user-details/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-user-details/description.md rename to apis/imodels/v2/operations/get-imodel-user-details/description.md diff --git a/services/imodels/v2/operations/get-imodel-user-details/displayName.md b/apis/imodels/v2/operations/get-imodel-user-details/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-user-details/displayName.md rename to apis/imodels/v2/operations/get-imodel-user-details/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-user-permissions/description.md b/apis/imodels/v2/operations/get-imodel-user-permissions/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-user-permissions/description.md rename to apis/imodels/v2/operations/get-imodel-user-permissions/description.md diff --git a/services/imodels/v2/operations/get-imodel-user-permissions/displayName.md b/apis/imodels/v2/operations/get-imodel-user-permissions/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-user-permissions/displayName.md rename to apis/imodels/v2/operations/get-imodel-user-permissions/displayName.md diff --git a/services/imodels/v2/operations/get-imodel-users/description.md b/apis/imodels/v2/operations/get-imodel-users/description.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-users/description.md rename to apis/imodels/v2/operations/get-imodel-users/description.md diff --git a/services/imodels/v2/operations/get-imodel-users/displayName.md b/apis/imodels/v2/operations/get-imodel-users/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-imodel-users/displayName.md rename to apis/imodels/v2/operations/get-imodel-users/displayName.md diff --git a/services/imodels/v2/operations/get-itwin-imodels/description.md b/apis/imodels/v2/operations/get-itwin-imodels/description.md similarity index 100% rename from services/imodels/v2/operations/get-itwin-imodels/description.md rename to apis/imodels/v2/operations/get-itwin-imodels/description.md diff --git a/services/imodels/v2/operations/get-itwin-imodels/displayName.md b/apis/imodels/v2/operations/get-itwin-imodels/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-itwin-imodels/displayName.md rename to apis/imodels/v2/operations/get-itwin-imodels/displayName.md diff --git a/services/imodels/v2/operations/get-named-version-checkpoint/description.md b/apis/imodels/v2/operations/get-named-version-checkpoint/description.md similarity index 100% rename from services/imodels/v2/operations/get-named-version-checkpoint/description.md rename to apis/imodels/v2/operations/get-named-version-checkpoint/description.md diff --git a/services/imodels/v2/operations/get-named-version-checkpoint/displayName.md b/apis/imodels/v2/operations/get-named-version-checkpoint/displayName.md similarity index 100% rename from services/imodels/v2/operations/get-named-version-checkpoint/displayName.md rename to apis/imodels/v2/operations/get-named-version-checkpoint/displayName.md diff --git a/services/imodels/v2/operations/release-imodel-briefcase/description.md b/apis/imodels/v2/operations/release-imodel-briefcase/description.md similarity index 100% rename from services/imodels/v2/operations/release-imodel-briefcase/description.md rename to apis/imodels/v2/operations/release-imodel-briefcase/description.md diff --git a/services/imodels/v2/operations/release-imodel-briefcase/displayName.md b/apis/imodels/v2/operations/release-imodel-briefcase/displayName.md similarity index 100% rename from services/imodels/v2/operations/release-imodel-briefcase/displayName.md rename to apis/imodels/v2/operations/release-imodel-briefcase/displayName.md diff --git a/services/imodels/v2/operations/revoke-imodel-share/description.md b/apis/imodels/v2/operations/revoke-imodel-share/description.md similarity index 100% rename from services/imodels/v2/operations/revoke-imodel-share/description.md rename to apis/imodels/v2/operations/revoke-imodel-share/description.md diff --git a/services/imodels/v2/operations/revoke-imodel-share/displayName.md b/apis/imodels/v2/operations/revoke-imodel-share/displayName.md similarity index 100% rename from services/imodels/v2/operations/revoke-imodel-share/displayName.md rename to apis/imodels/v2/operations/revoke-imodel-share/displayName.md diff --git a/services/imodels/v2/operations/update-imodel-changeset-group/description.md b/apis/imodels/v2/operations/update-imodel-changeset-group/description.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-changeset-group/description.md rename to apis/imodels/v2/operations/update-imodel-changeset-group/description.md diff --git a/services/imodels/v2/operations/update-imodel-changeset-group/displayName.md b/apis/imodels/v2/operations/update-imodel-changeset-group/displayName.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-changeset-group/displayName.md rename to apis/imodels/v2/operations/update-imodel-changeset-group/displayName.md diff --git a/services/imodels/v2/operations/update-imodel-changeset/description.md b/apis/imodels/v2/operations/update-imodel-changeset/description.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-changeset/description.md rename to apis/imodels/v2/operations/update-imodel-changeset/description.md diff --git a/services/imodels/v2/operations/update-imodel-changeset/displayName.md b/apis/imodels/v2/operations/update-imodel-changeset/displayName.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-changeset/displayName.md rename to apis/imodels/v2/operations/update-imodel-changeset/displayName.md diff --git a/services/imodels/v2/operations/update-imodel-locks/description.md b/apis/imodels/v2/operations/update-imodel-locks/description.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-locks/description.md rename to apis/imodels/v2/operations/update-imodel-locks/description.md diff --git a/services/imodels/v2/operations/update-imodel-locks/displayName.md b/apis/imodels/v2/operations/update-imodel-locks/displayName.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-locks/displayName.md rename to apis/imodels/v2/operations/update-imodel-locks/displayName.md diff --git a/services/imodels/v2/operations/update-imodel-named-version/description.md b/apis/imodels/v2/operations/update-imodel-named-version/description.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-named-version/description.md rename to apis/imodels/v2/operations/update-imodel-named-version/description.md diff --git a/services/imodels/v2/operations/update-imodel-named-version/displayName.md b/apis/imodels/v2/operations/update-imodel-named-version/displayName.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-named-version/displayName.md rename to apis/imodels/v2/operations/update-imodel-named-version/displayName.md diff --git a/services/imodels/v2/operations/update-imodel-role-permissions/description.md b/apis/imodels/v2/operations/update-imodel-role-permissions/description.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-role-permissions/description.md rename to apis/imodels/v2/operations/update-imodel-role-permissions/description.md diff --git a/services/imodels/v2/operations/update-imodel-role-permissions/displayName.md b/apis/imodels/v2/operations/update-imodel-role-permissions/displayName.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-role-permissions/displayName.md rename to apis/imodels/v2/operations/update-imodel-role-permissions/displayName.md diff --git a/services/imodels/v2/operations/update-imodel-share/description.md b/apis/imodels/v2/operations/update-imodel-share/description.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-share/description.md rename to apis/imodels/v2/operations/update-imodel-share/description.md diff --git a/services/imodels/v2/operations/update-imodel-share/displayName.md b/apis/imodels/v2/operations/update-imodel-share/displayName.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-share/displayName.md rename to apis/imodels/v2/operations/update-imodel-share/displayName.md diff --git a/services/imodels/v2/operations/update-imodel-user-permissions/description.md b/apis/imodels/v2/operations/update-imodel-user-permissions/description.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-user-permissions/description.md rename to apis/imodels/v2/operations/update-imodel-user-permissions/description.md diff --git a/services/imodels/v2/operations/update-imodel-user-permissions/displayName.md b/apis/imodels/v2/operations/update-imodel-user-permissions/displayName.md similarity index 100% rename from services/imodels/v2/operations/update-imodel-user-permissions/displayName.md rename to apis/imodels/v2/operations/update-imodel-user-permissions/displayName.md diff --git a/services/imodels/v2/operations/update-imodel/description.md b/apis/imodels/v2/operations/update-imodel/description.md similarity index 100% rename from services/imodels/v2/operations/update-imodel/description.md rename to apis/imodels/v2/operations/update-imodel/description.md diff --git a/services/imodels/v2/operations/update-imodel/displayName.md b/apis/imodels/v2/operations/update-imodel/displayName.md similarity index 100% rename from services/imodels/v2/operations/update-imodel/displayName.md rename to apis/imodels/v2/operations/update-imodel/displayName.md diff --git a/services/imodels/v2/operations/upload-imodel-thumbnail/description.md b/apis/imodels/v2/operations/upload-imodel-thumbnail/description.md similarity index 100% rename from services/imodels/v2/operations/upload-imodel-thumbnail/description.md rename to apis/imodels/v2/operations/upload-imodel-thumbnail/description.md diff --git a/services/imodels/v2/operations/upload-imodel-thumbnail/displayName.md b/apis/imodels/v2/operations/upload-imodel-thumbnail/displayName.md similarity index 100% rename from services/imodels/v2/operations/upload-imodel-thumbnail/displayName.md rename to apis/imodels/v2/operations/upload-imodel-thumbnail/displayName.md diff --git a/services/issues/v1/description.md b/apis/issues/v1/description.md similarity index 100% rename from services/issues/v1/description.md rename to apis/issues/v1/description.md diff --git a/services/issues/v1/operations/add-attachment-to-issue/description.md b/apis/issues/v1/operations/add-attachment-to-issue/description.md similarity index 100% rename from services/issues/v1/operations/add-attachment-to-issue/description.md rename to apis/issues/v1/operations/add-attachment-to-issue/description.md diff --git a/services/issues/v1/operations/add-attachment-to-issue/displayName.md b/apis/issues/v1/operations/add-attachment-to-issue/displayName.md similarity index 100% rename from services/issues/v1/operations/add-attachment-to-issue/displayName.md rename to apis/issues/v1/operations/add-attachment-to-issue/displayName.md diff --git a/services/issues/v1/operations/add-comment-to-issue/description.md b/apis/issues/v1/operations/add-comment-to-issue/description.md similarity index 100% rename from services/issues/v1/operations/add-comment-to-issue/description.md rename to apis/issues/v1/operations/add-comment-to-issue/description.md diff --git a/services/issues/v1/operations/add-comment-to-issue/displayName.md b/apis/issues/v1/operations/add-comment-to-issue/displayName.md similarity index 100% rename from services/issues/v1/operations/add-comment-to-issue/displayName.md rename to apis/issues/v1/operations/add-comment-to-issue/displayName.md diff --git a/services/issues/v1/operations/create-issue/description.md b/apis/issues/v1/operations/create-issue/description.md similarity index 100% rename from services/issues/v1/operations/create-issue/description.md rename to apis/issues/v1/operations/create-issue/description.md diff --git a/services/issues/v1/operations/create-issue/displayName.md b/apis/issues/v1/operations/create-issue/displayName.md similarity index 100% rename from services/issues/v1/operations/create-issue/displayName.md rename to apis/issues/v1/operations/create-issue/displayName.md diff --git a/services/issues/v1/operations/delete-attachment/description.md b/apis/issues/v1/operations/delete-attachment/description.md similarity index 100% rename from services/issues/v1/operations/delete-attachment/description.md rename to apis/issues/v1/operations/delete-attachment/description.md diff --git a/services/issues/v1/operations/delete-attachment/displayName.md b/apis/issues/v1/operations/delete-attachment/displayName.md similarity index 100% rename from services/issues/v1/operations/delete-attachment/displayName.md rename to apis/issues/v1/operations/delete-attachment/displayName.md diff --git a/services/issues/v1/operations/delete-comment/description.md b/apis/issues/v1/operations/delete-comment/description.md similarity index 100% rename from services/issues/v1/operations/delete-comment/description.md rename to apis/issues/v1/operations/delete-comment/description.md diff --git a/services/issues/v1/operations/delete-comment/displayName.md b/apis/issues/v1/operations/delete-comment/displayName.md similarity index 100% rename from services/issues/v1/operations/delete-comment/displayName.md rename to apis/issues/v1/operations/delete-comment/displayName.md diff --git a/services/issues/v1/operations/delete-issue/description.md b/apis/issues/v1/operations/delete-issue/description.md similarity index 100% rename from services/issues/v1/operations/delete-issue/description.md rename to apis/issues/v1/operations/delete-issue/description.md diff --git a/services/issues/v1/operations/delete-issue/displayName.md b/apis/issues/v1/operations/delete-issue/displayName.md similarity index 100% rename from services/issues/v1/operations/delete-issue/displayName.md rename to apis/issues/v1/operations/delete-issue/displayName.md diff --git a/services/issues/v1/operations/download-issue-as-file/description.md b/apis/issues/v1/operations/download-issue-as-file/description.md similarity index 100% rename from services/issues/v1/operations/download-issue-as-file/description.md rename to apis/issues/v1/operations/download-issue-as-file/description.md diff --git a/services/issues/v1/operations/download-issue-as-file/displayName.md b/apis/issues/v1/operations/download-issue-as-file/displayName.md similarity index 100% rename from services/issues/v1/operations/download-issue-as-file/displayName.md rename to apis/issues/v1/operations/download-issue-as-file/displayName.md diff --git a/services/issues/v1/operations/export-issues-to-storage/description.md b/apis/issues/v1/operations/export-issues-to-storage/description.md similarity index 100% rename from services/issues/v1/operations/export-issues-to-storage/description.md rename to apis/issues/v1/operations/export-issues-to-storage/description.md diff --git a/services/issues/v1/operations/export-issues-to-storage/displayName.md b/apis/issues/v1/operations/export-issues-to-storage/displayName.md similarity index 100% rename from services/issues/v1/operations/export-issues-to-storage/displayName.md rename to apis/issues/v1/operations/export-issues-to-storage/displayName.md diff --git a/services/issues/v1/operations/get-attachment-by-id/description.md b/apis/issues/v1/operations/get-attachment-by-id/description.md similarity index 100% rename from services/issues/v1/operations/get-attachment-by-id/description.md rename to apis/issues/v1/operations/get-attachment-by-id/description.md diff --git a/services/issues/v1/operations/get-attachment-by-id/displayName.md b/apis/issues/v1/operations/get-attachment-by-id/displayName.md similarity index 100% rename from services/issues/v1/operations/get-attachment-by-id/displayName.md rename to apis/issues/v1/operations/get-attachment-by-id/displayName.md diff --git a/services/issues/v1/operations/get-form-definition-by-id/description.md b/apis/issues/v1/operations/get-form-definition-by-id/description.md similarity index 100% rename from services/issues/v1/operations/get-form-definition-by-id/description.md rename to apis/issues/v1/operations/get-form-definition-by-id/description.md diff --git a/services/issues/v1/operations/get-form-definition-by-id/displayName.md b/apis/issues/v1/operations/get-form-definition-by-id/displayName.md similarity index 100% rename from services/issues/v1/operations/get-form-definition-by-id/displayName.md rename to apis/issues/v1/operations/get-form-definition-by-id/displayName.md diff --git a/services/issues/v1/operations/get-issue-attachments/description.md b/apis/issues/v1/operations/get-issue-attachments/description.md similarity index 100% rename from services/issues/v1/operations/get-issue-attachments/description.md rename to apis/issues/v1/operations/get-issue-attachments/description.md diff --git a/services/issues/v1/operations/get-issue-attachments/displayName.md b/apis/issues/v1/operations/get-issue-attachments/displayName.md similarity index 100% rename from services/issues/v1/operations/get-issue-attachments/displayName.md rename to apis/issues/v1/operations/get-issue-attachments/displayName.md diff --git a/services/issues/v1/operations/get-issue-audit-trail/description.md b/apis/issues/v1/operations/get-issue-audit-trail/description.md similarity index 100% rename from services/issues/v1/operations/get-issue-audit-trail/description.md rename to apis/issues/v1/operations/get-issue-audit-trail/description.md diff --git a/services/issues/v1/operations/get-issue-audit-trail/displayName.md b/apis/issues/v1/operations/get-issue-audit-trail/displayName.md similarity index 100% rename from services/issues/v1/operations/get-issue-audit-trail/displayName.md rename to apis/issues/v1/operations/get-issue-audit-trail/displayName.md diff --git a/services/issues/v1/operations/get-issue-comments/description.md b/apis/issues/v1/operations/get-issue-comments/description.md similarity index 100% rename from services/issues/v1/operations/get-issue-comments/description.md rename to apis/issues/v1/operations/get-issue-comments/description.md diff --git a/services/issues/v1/operations/get-issue-comments/displayName.md b/apis/issues/v1/operations/get-issue-comments/displayName.md similarity index 100% rename from services/issues/v1/operations/get-issue-comments/displayName.md rename to apis/issues/v1/operations/get-issue-comments/displayName.md diff --git a/services/issues/v1/operations/get-issue-details/description.md b/apis/issues/v1/operations/get-issue-details/description.md similarity index 100% rename from services/issues/v1/operations/get-issue-details/description.md rename to apis/issues/v1/operations/get-issue-details/description.md diff --git a/services/issues/v1/operations/get-issue-details/displayName.md b/apis/issues/v1/operations/get-issue-details/displayName.md similarity index 100% rename from services/issues/v1/operations/get-issue-details/displayName.md rename to apis/issues/v1/operations/get-issue-details/displayName.md diff --git a/services/issues/v1/operations/get-list-group/description.md b/apis/issues/v1/operations/get-list-group/description.md similarity index 100% rename from services/issues/v1/operations/get-list-group/description.md rename to apis/issues/v1/operations/get-list-group/description.md diff --git a/services/issues/v1/operations/get-list-group/displayName.md b/apis/issues/v1/operations/get-list-group/displayName.md similarity index 100% rename from services/issues/v1/operations/get-list-group/displayName.md rename to apis/issues/v1/operations/get-list-group/displayName.md diff --git a/services/issues/v1/operations/get-project-form-definitions/description.md b/apis/issues/v1/operations/get-project-form-definitions/description.md similarity index 100% rename from services/issues/v1/operations/get-project-form-definitions/description.md rename to apis/issues/v1/operations/get-project-form-definitions/description.md diff --git a/services/issues/v1/operations/get-project-form-definitions/displayName.md b/apis/issues/v1/operations/get-project-form-definitions/displayName.md similarity index 100% rename from services/issues/v1/operations/get-project-form-definitions/displayName.md rename to apis/issues/v1/operations/get-project-form-definitions/displayName.md diff --git a/services/issues/v1/operations/get-project-issues/description.md b/apis/issues/v1/operations/get-project-issues/description.md similarity index 100% rename from services/issues/v1/operations/get-project-issues/description.md rename to apis/issues/v1/operations/get-project-issues/description.md diff --git a/services/issues/v1/operations/get-project-issues/displayName.md b/apis/issues/v1/operations/get-project-issues/displayName.md similarity index 100% rename from services/issues/v1/operations/get-project-issues/displayName.md rename to apis/issues/v1/operations/get-project-issues/displayName.md diff --git a/services/issues/v1/operations/get-static-image/description.md b/apis/issues/v1/operations/get-static-image/description.md similarity index 100% rename from services/issues/v1/operations/get-static-image/description.md rename to apis/issues/v1/operations/get-static-image/description.md diff --git a/services/issues/v1/operations/get-static-image/displayName.md b/apis/issues/v1/operations/get-static-image/displayName.md similarity index 100% rename from services/issues/v1/operations/get-static-image/displayName.md rename to apis/issues/v1/operations/get-static-image/displayName.md diff --git a/services/issues/v1/operations/get-workflow/description.md b/apis/issues/v1/operations/get-workflow/description.md similarity index 100% rename from services/issues/v1/operations/get-workflow/description.md rename to apis/issues/v1/operations/get-workflow/description.md diff --git a/services/issues/v1/operations/get-workflow/displayName.md b/apis/issues/v1/operations/get-workflow/displayName.md similarity index 100% rename from services/issues/v1/operations/get-workflow/displayName.md rename to apis/issues/v1/operations/get-workflow/displayName.md diff --git a/services/issues/v1/operations/modify-issue/description.md b/apis/issues/v1/operations/modify-issue/description.md similarity index 100% rename from services/issues/v1/operations/modify-issue/description.md rename to apis/issues/v1/operations/modify-issue/description.md diff --git a/services/issues/v1/operations/modify-issue/displayName.md b/apis/issues/v1/operations/modify-issue/displayName.md similarity index 100% rename from services/issues/v1/operations/modify-issue/displayName.md rename to apis/issues/v1/operations/modify-issue/displayName.md diff --git a/services/issues/v1/operations/upload-attachment-file/description.md b/apis/issues/v1/operations/upload-attachment-file/description.md similarity index 100% rename from services/issues/v1/operations/upload-attachment-file/description.md rename to apis/issues/v1/operations/upload-attachment-file/description.md diff --git a/services/issues/v1/operations/upload-attachment-file/displayName.md b/apis/issues/v1/operations/upload-attachment-file/displayName.md similarity index 100% rename from services/issues/v1/operations/upload-attachment-file/displayName.md rename to apis/issues/v1/operations/upload-attachment-file/displayName.md diff --git a/services/itwin-entities/v1/description.md b/apis/itwin-entities/v1/description.md similarity index 100% rename from services/itwin-entities/v1/description.md rename to apis/itwin-entities/v1/description.md diff --git a/services/itwin-entities/v1/operations/create-entity/description.md b/apis/itwin-entities/v1/operations/create-entity/description.md similarity index 100% rename from services/itwin-entities/v1/operations/create-entity/description.md rename to apis/itwin-entities/v1/operations/create-entity/description.md diff --git a/services/itwin-entities/v1/operations/create-entity/displayName.md b/apis/itwin-entities/v1/operations/create-entity/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/create-entity/displayName.md rename to apis/itwin-entities/v1/operations/create-entity/displayName.md diff --git a/services/itwin-entities/v1/operations/create-hierarchy-nodes/description.md b/apis/itwin-entities/v1/operations/create-hierarchy-nodes/description.md similarity index 100% rename from services/itwin-entities/v1/operations/create-hierarchy-nodes/description.md rename to apis/itwin-entities/v1/operations/create-hierarchy-nodes/description.md diff --git a/services/itwin-entities/v1/operations/create-hierarchy-nodes/displayName.md b/apis/itwin-entities/v1/operations/create-hierarchy-nodes/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/create-hierarchy-nodes/displayName.md rename to apis/itwin-entities/v1/operations/create-hierarchy-nodes/displayName.md diff --git a/services/itwin-entities/v1/operations/create-hierarchy/description.md b/apis/itwin-entities/v1/operations/create-hierarchy/description.md similarity index 100% rename from services/itwin-entities/v1/operations/create-hierarchy/description.md rename to apis/itwin-entities/v1/operations/create-hierarchy/description.md diff --git a/services/itwin-entities/v1/operations/create-hierarchy/displayName.md b/apis/itwin-entities/v1/operations/create-hierarchy/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/create-hierarchy/displayName.md rename to apis/itwin-entities/v1/operations/create-hierarchy/displayName.md diff --git a/services/itwin-entities/v1/operations/create-link/description.md b/apis/itwin-entities/v1/operations/create-link/description.md similarity index 100% rename from services/itwin-entities/v1/operations/create-link/description.md rename to apis/itwin-entities/v1/operations/create-link/description.md diff --git a/services/itwin-entities/v1/operations/create-link/displayName.md b/apis/itwin-entities/v1/operations/create-link/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/create-link/displayName.md rename to apis/itwin-entities/v1/operations/create-link/displayName.md diff --git a/services/itwin-entities/v1/operations/delete-entity/description.md b/apis/itwin-entities/v1/operations/delete-entity/description.md similarity index 100% rename from services/itwin-entities/v1/operations/delete-entity/description.md rename to apis/itwin-entities/v1/operations/delete-entity/description.md diff --git a/services/itwin-entities/v1/operations/delete-entity/displayName.md b/apis/itwin-entities/v1/operations/delete-entity/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/delete-entity/displayName.md rename to apis/itwin-entities/v1/operations/delete-entity/displayName.md diff --git a/services/itwin-entities/v1/operations/delete-hierarchy-node/description.md b/apis/itwin-entities/v1/operations/delete-hierarchy-node/description.md similarity index 100% rename from services/itwin-entities/v1/operations/delete-hierarchy-node/description.md rename to apis/itwin-entities/v1/operations/delete-hierarchy-node/description.md diff --git a/services/itwin-entities/v1/operations/delete-hierarchy-node/displayName.md b/apis/itwin-entities/v1/operations/delete-hierarchy-node/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/delete-hierarchy-node/displayName.md rename to apis/itwin-entities/v1/operations/delete-hierarchy-node/displayName.md diff --git a/services/itwin-entities/v1/operations/delete-hierarchy/description.md b/apis/itwin-entities/v1/operations/delete-hierarchy/description.md similarity index 100% rename from services/itwin-entities/v1/operations/delete-hierarchy/description.md rename to apis/itwin-entities/v1/operations/delete-hierarchy/description.md diff --git a/services/itwin-entities/v1/operations/delete-hierarchy/displayName.md b/apis/itwin-entities/v1/operations/delete-hierarchy/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/delete-hierarchy/displayName.md rename to apis/itwin-entities/v1/operations/delete-hierarchy/displayName.md diff --git a/services/itwin-entities/v1/operations/delete-link/description.md b/apis/itwin-entities/v1/operations/delete-link/description.md similarity index 100% rename from services/itwin-entities/v1/operations/delete-link/description.md rename to apis/itwin-entities/v1/operations/delete-link/description.md diff --git a/services/itwin-entities/v1/operations/delete-link/displayName.md b/apis/itwin-entities/v1/operations/delete-link/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/delete-link/displayName.md rename to apis/itwin-entities/v1/operations/delete-link/displayName.md diff --git a/services/itwin-entities/v1/operations/get-entities/description.md b/apis/itwin-entities/v1/operations/get-entities/description.md similarity index 100% rename from services/itwin-entities/v1/operations/get-entities/description.md rename to apis/itwin-entities/v1/operations/get-entities/description.md diff --git a/services/itwin-entities/v1/operations/get-entities/displayName.md b/apis/itwin-entities/v1/operations/get-entities/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/get-entities/displayName.md rename to apis/itwin-entities/v1/operations/get-entities/displayName.md diff --git a/services/itwin-entities/v1/operations/get-entity/description.md b/apis/itwin-entities/v1/operations/get-entity/description.md similarity index 100% rename from services/itwin-entities/v1/operations/get-entity/description.md rename to apis/itwin-entities/v1/operations/get-entity/description.md diff --git a/services/itwin-entities/v1/operations/get-entity/displayName.md b/apis/itwin-entities/v1/operations/get-entity/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/get-entity/displayName.md rename to apis/itwin-entities/v1/operations/get-entity/displayName.md diff --git a/services/itwin-entities/v1/operations/get-hierarchies/description.md b/apis/itwin-entities/v1/operations/get-hierarchies/description.md similarity index 100% rename from services/itwin-entities/v1/operations/get-hierarchies/description.md rename to apis/itwin-entities/v1/operations/get-hierarchies/description.md diff --git a/services/itwin-entities/v1/operations/get-hierarchies/displayName.md b/apis/itwin-entities/v1/operations/get-hierarchies/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/get-hierarchies/displayName.md rename to apis/itwin-entities/v1/operations/get-hierarchies/displayName.md diff --git a/services/itwin-entities/v1/operations/get-hierarchy-nodes/description.md b/apis/itwin-entities/v1/operations/get-hierarchy-nodes/description.md similarity index 100% rename from services/itwin-entities/v1/operations/get-hierarchy-nodes/description.md rename to apis/itwin-entities/v1/operations/get-hierarchy-nodes/description.md diff --git a/services/itwin-entities/v1/operations/get-hierarchy-nodes/displayName.md b/apis/itwin-entities/v1/operations/get-hierarchy-nodes/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/get-hierarchy-nodes/displayName.md rename to apis/itwin-entities/v1/operations/get-hierarchy-nodes/displayName.md diff --git a/services/itwin-entities/v1/operations/get-hierarchy/description.md b/apis/itwin-entities/v1/operations/get-hierarchy/description.md similarity index 100% rename from services/itwin-entities/v1/operations/get-hierarchy/description.md rename to apis/itwin-entities/v1/operations/get-hierarchy/description.md diff --git a/services/itwin-entities/v1/operations/get-hierarchy/displayName.md b/apis/itwin-entities/v1/operations/get-hierarchy/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/get-hierarchy/displayName.md rename to apis/itwin-entities/v1/operations/get-hierarchy/displayName.md diff --git a/services/itwin-entities/v1/operations/get-links/description.md b/apis/itwin-entities/v1/operations/get-links/description.md similarity index 100% rename from services/itwin-entities/v1/operations/get-links/description.md rename to apis/itwin-entities/v1/operations/get-links/description.md diff --git a/services/itwin-entities/v1/operations/get-links/displayName.md b/apis/itwin-entities/v1/operations/get-links/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/get-links/displayName.md rename to apis/itwin-entities/v1/operations/get-links/displayName.md diff --git a/services/itwin-entities/v1/operations/update-entity/description.md b/apis/itwin-entities/v1/operations/update-entity/description.md similarity index 100% rename from services/itwin-entities/v1/operations/update-entity/description.md rename to apis/itwin-entities/v1/operations/update-entity/description.md diff --git a/services/itwin-entities/v1/operations/update-entity/displayName.md b/apis/itwin-entities/v1/operations/update-entity/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/update-entity/displayName.md rename to apis/itwin-entities/v1/operations/update-entity/displayName.md diff --git a/services/itwin-entities/v1/operations/update-hierarchy/description.md b/apis/itwin-entities/v1/operations/update-hierarchy/description.md similarity index 100% rename from services/itwin-entities/v1/operations/update-hierarchy/description.md rename to apis/itwin-entities/v1/operations/update-hierarchy/description.md diff --git a/services/itwin-entities/v1/operations/update-hierarchy/displayName.md b/apis/itwin-entities/v1/operations/update-hierarchy/displayName.md similarity index 100% rename from services/itwin-entities/v1/operations/update-hierarchy/displayName.md rename to apis/itwin-entities/v1/operations/update-hierarchy/displayName.md diff --git a/services/itwin-search/v1/description.md b/apis/itwin-search/v1/description.md similarity index 100% rename from services/itwin-search/v1/description.md rename to apis/itwin-search/v1/description.md diff --git a/services/itwin-search/v1/operations/discover/description.md b/apis/itwin-search/v1/operations/discover/description.md similarity index 100% rename from services/itwin-search/v1/operations/discover/description.md rename to apis/itwin-search/v1/operations/discover/description.md diff --git a/services/itwin-search/v1/operations/discover/displayName.md b/apis/itwin-search/v1/operations/discover/displayName.md similarity index 100% rename from services/itwin-search/v1/operations/discover/displayName.md rename to apis/itwin-search/v1/operations/discover/displayName.md diff --git a/services/itwin-search/v1/operations/post-search/description.md b/apis/itwin-search/v1/operations/post-search/description.md similarity index 100% rename from services/itwin-search/v1/operations/post-search/description.md rename to apis/itwin-search/v1/operations/post-search/description.md diff --git a/services/itwin-search/v1/operations/post-search/displayName.md b/apis/itwin-search/v1/operations/post-search/displayName.md similarity index 100% rename from services/itwin-search/v1/operations/post-search/displayName.md rename to apis/itwin-search/v1/operations/post-search/displayName.md diff --git a/services/itwins/v1/description.md b/apis/itwins/v1/description.md similarity index 100% rename from services/itwins/v1/description.md rename to apis/itwins/v1/description.md diff --git a/services/itwins/v1/operations/add-itwin-to-my-favorites/description.md b/apis/itwins/v1/operations/add-itwin-to-my-favorites/description.md similarity index 100% rename from services/itwins/v1/operations/add-itwin-to-my-favorites/description.md rename to apis/itwins/v1/operations/add-itwin-to-my-favorites/description.md diff --git a/services/itwins/v1/operations/add-itwin-to-my-favorites/displayName.md b/apis/itwins/v1/operations/add-itwin-to-my-favorites/displayName.md similarity index 100% rename from services/itwins/v1/operations/add-itwin-to-my-favorites/displayName.md rename to apis/itwins/v1/operations/add-itwin-to-my-favorites/displayName.md diff --git a/services/itwins/v1/operations/add-itwin-to-my-recents/description.md b/apis/itwins/v1/operations/add-itwin-to-my-recents/description.md similarity index 100% rename from services/itwins/v1/operations/add-itwin-to-my-recents/description.md rename to apis/itwins/v1/operations/add-itwin-to-my-recents/description.md diff --git a/services/itwins/v1/operations/add-itwin-to-my-recents/displayName.md b/apis/itwins/v1/operations/add-itwin-to-my-recents/displayName.md similarity index 100% rename from services/itwins/v1/operations/add-itwin-to-my-recents/displayName.md rename to apis/itwins/v1/operations/add-itwin-to-my-recents/displayName.md diff --git a/services/itwins/v1/operations/create-itwin/description.md b/apis/itwins/v1/operations/create-itwin/description.md similarity index 100% rename from services/itwins/v1/operations/create-itwin/description.md rename to apis/itwins/v1/operations/create-itwin/description.md diff --git a/services/itwins/v1/operations/create-itwin/displayName.md b/apis/itwins/v1/operations/create-itwin/displayName.md similarity index 100% rename from services/itwins/v1/operations/create-itwin/displayName.md rename to apis/itwins/v1/operations/create-itwin/displayName.md diff --git a/services/itwins/v1/operations/create-repository/description.md b/apis/itwins/v1/operations/create-repository/description.md similarity index 100% rename from services/itwins/v1/operations/create-repository/description.md rename to apis/itwins/v1/operations/create-repository/description.md diff --git a/services/itwins/v1/operations/create-repository/displayName.md b/apis/itwins/v1/operations/create-repository/displayName.md similarity index 100% rename from services/itwins/v1/operations/create-repository/displayName.md rename to apis/itwins/v1/operations/create-repository/displayName.md diff --git a/services/itwins/v1/operations/delete-itwin-image/description.md b/apis/itwins/v1/operations/delete-itwin-image/description.md similarity index 100% rename from services/itwins/v1/operations/delete-itwin-image/description.md rename to apis/itwins/v1/operations/delete-itwin-image/description.md diff --git a/services/itwins/v1/operations/delete-itwin-image/displayName.md b/apis/itwins/v1/operations/delete-itwin-image/displayName.md similarity index 100% rename from services/itwins/v1/operations/delete-itwin-image/displayName.md rename to apis/itwins/v1/operations/delete-itwin-image/displayName.md diff --git a/services/itwins/v1/operations/delete-itwin/description.md b/apis/itwins/v1/operations/delete-itwin/description.md similarity index 100% rename from services/itwins/v1/operations/delete-itwin/description.md rename to apis/itwins/v1/operations/delete-itwin/description.md diff --git a/services/itwins/v1/operations/delete-itwin/displayName.md b/apis/itwins/v1/operations/delete-itwin/displayName.md similarity index 100% rename from services/itwins/v1/operations/delete-itwin/displayName.md rename to apis/itwins/v1/operations/delete-itwin/displayName.md diff --git a/services/itwins/v1/operations/delete-repository/description.md b/apis/itwins/v1/operations/delete-repository/description.md similarity index 100% rename from services/itwins/v1/operations/delete-repository/description.md rename to apis/itwins/v1/operations/delete-repository/description.md diff --git a/services/itwins/v1/operations/delete-repository/displayName.md b/apis/itwins/v1/operations/delete-repository/displayName.md similarity index 100% rename from services/itwins/v1/operations/delete-repository/displayName.md rename to apis/itwins/v1/operations/delete-repository/displayName.md diff --git a/services/itwins/v1/operations/get-itwin-account/description.md b/apis/itwins/v1/operations/get-itwin-account/description.md similarity index 100% rename from services/itwins/v1/operations/get-itwin-account/description.md rename to apis/itwins/v1/operations/get-itwin-account/description.md diff --git a/services/itwins/v1/operations/get-itwin-account/displayName.md b/apis/itwins/v1/operations/get-itwin-account/displayName.md similarity index 100% rename from services/itwins/v1/operations/get-itwin-account/displayName.md rename to apis/itwins/v1/operations/get-itwin-account/displayName.md diff --git a/services/itwins/v1/operations/get-itwin-image/description.md b/apis/itwins/v1/operations/get-itwin-image/description.md similarity index 100% rename from services/itwins/v1/operations/get-itwin-image/description.md rename to apis/itwins/v1/operations/get-itwin-image/description.md diff --git a/services/itwins/v1/operations/get-itwin-image/displayName.md b/apis/itwins/v1/operations/get-itwin-image/displayName.md similarity index 100% rename from services/itwins/v1/operations/get-itwin-image/displayName.md rename to apis/itwins/v1/operations/get-itwin-image/displayName.md diff --git a/services/itwins/v1/operations/get-itwin/description.md b/apis/itwins/v1/operations/get-itwin/description.md similarity index 100% rename from services/itwins/v1/operations/get-itwin/description.md rename to apis/itwins/v1/operations/get-itwin/description.md diff --git a/services/itwins/v1/operations/get-itwin/displayName.md b/apis/itwins/v1/operations/get-itwin/displayName.md similarity index 100% rename from services/itwins/v1/operations/get-itwin/displayName.md rename to apis/itwins/v1/operations/get-itwin/displayName.md diff --git a/services/itwins/v1/operations/get-my-favorite-itwins/description.md b/apis/itwins/v1/operations/get-my-favorite-itwins/description.md similarity index 100% rename from services/itwins/v1/operations/get-my-favorite-itwins/description.md rename to apis/itwins/v1/operations/get-my-favorite-itwins/description.md diff --git a/services/itwins/v1/operations/get-my-favorite-itwins/displayName.md b/apis/itwins/v1/operations/get-my-favorite-itwins/displayName.md similarity index 100% rename from services/itwins/v1/operations/get-my-favorite-itwins/displayName.md rename to apis/itwins/v1/operations/get-my-favorite-itwins/displayName.md diff --git a/services/itwins/v1/operations/get-my-itwins/description.md b/apis/itwins/v1/operations/get-my-itwins/description.md similarity index 100% rename from services/itwins/v1/operations/get-my-itwins/description.md rename to apis/itwins/v1/operations/get-my-itwins/description.md diff --git a/services/itwins/v1/operations/get-my-itwins/displayName.md b/apis/itwins/v1/operations/get-my-itwins/displayName.md similarity index 100% rename from services/itwins/v1/operations/get-my-itwins/displayName.md rename to apis/itwins/v1/operations/get-my-itwins/displayName.md diff --git a/services/itwins/v1/operations/get-my-primary-account/description.md b/apis/itwins/v1/operations/get-my-primary-account/description.md similarity index 100% rename from services/itwins/v1/operations/get-my-primary-account/description.md rename to apis/itwins/v1/operations/get-my-primary-account/description.md diff --git a/services/itwins/v1/operations/get-my-primary-account/displayName.md b/apis/itwins/v1/operations/get-my-primary-account/displayName.md similarity index 100% rename from services/itwins/v1/operations/get-my-primary-account/displayName.md rename to apis/itwins/v1/operations/get-my-primary-account/displayName.md diff --git a/services/itwins/v1/operations/get-my-recently-used-itwins/description.md b/apis/itwins/v1/operations/get-my-recently-used-itwins/description.md similarity index 100% rename from services/itwins/v1/operations/get-my-recently-used-itwins/description.md rename to apis/itwins/v1/operations/get-my-recently-used-itwins/description.md diff --git a/services/itwins/v1/operations/get-my-recently-used-itwins/displayName.md b/apis/itwins/v1/operations/get-my-recently-used-itwins/displayName.md similarity index 100% rename from services/itwins/v1/operations/get-my-recently-used-itwins/displayName.md rename to apis/itwins/v1/operations/get-my-recently-used-itwins/displayName.md diff --git a/services/itwins/v1/operations/get-repositories-by-itwin-id/description.md b/apis/itwins/v1/operations/get-repositories-by-itwin-id/description.md similarity index 100% rename from services/itwins/v1/operations/get-repositories-by-itwin-id/description.md rename to apis/itwins/v1/operations/get-repositories-by-itwin-id/description.md diff --git a/services/itwins/v1/operations/get-repositories-by-itwin-id/displayName.md b/apis/itwins/v1/operations/get-repositories-by-itwin-id/displayName.md similarity index 100% rename from services/itwins/v1/operations/get-repositories-by-itwin-id/displayName.md rename to apis/itwins/v1/operations/get-repositories-by-itwin-id/displayName.md diff --git a/services/itwins/v1/operations/remove-itwin-from-my-favorites/description.md b/apis/itwins/v1/operations/remove-itwin-from-my-favorites/description.md similarity index 100% rename from services/itwins/v1/operations/remove-itwin-from-my-favorites/description.md rename to apis/itwins/v1/operations/remove-itwin-from-my-favorites/description.md diff --git a/services/itwins/v1/operations/remove-itwin-from-my-favorites/displayName.md b/apis/itwins/v1/operations/remove-itwin-from-my-favorites/displayName.md similarity index 100% rename from services/itwins/v1/operations/remove-itwin-from-my-favorites/displayName.md rename to apis/itwins/v1/operations/remove-itwin-from-my-favorites/displayName.md diff --git a/services/itwins/v1/operations/update-itwin/description.md b/apis/itwins/v1/operations/update-itwin/description.md similarity index 100% rename from services/itwins/v1/operations/update-itwin/description.md rename to apis/itwins/v1/operations/update-itwin/description.md diff --git a/services/itwins/v1/operations/update-itwin/displayName.md b/apis/itwins/v1/operations/update-itwin/displayName.md similarity index 100% rename from services/itwins/v1/operations/update-itwin/displayName.md rename to apis/itwins/v1/operations/update-itwin/displayName.md diff --git a/services/itwins/v1/operations/upload-itwin-image/description.md b/apis/itwins/v1/operations/upload-itwin-image/description.md similarity index 100% rename from services/itwins/v1/operations/upload-itwin-image/description.md rename to apis/itwins/v1/operations/upload-itwin-image/description.md diff --git a/services/itwins/v1/operations/upload-itwin-image/displayName.md b/apis/itwins/v1/operations/upload-itwin-image/displayName.md similarity index 100% rename from services/itwins/v1/operations/upload-itwin-image/displayName.md rename to apis/itwins/v1/operations/upload-itwin-image/displayName.md diff --git a/services/library/v1/description.md b/apis/library/v1/description.md similarity index 100% rename from services/library/v1/description.md rename to apis/library/v1/description.md diff --git a/services/library/v1/operations/create-application/description.md b/apis/library/v1/operations/create-application/description.md similarity index 100% rename from services/library/v1/operations/create-application/description.md rename to apis/library/v1/operations/create-application/description.md diff --git a/services/library/v1/operations/create-application/displayName.md b/apis/library/v1/operations/create-application/displayName.md similarity index 100% rename from services/library/v1/operations/create-application/displayName.md rename to apis/library/v1/operations/create-application/displayName.md diff --git a/services/library/v1/operations/create-catalog-document/description.md b/apis/library/v1/operations/create-catalog-document/description.md similarity index 100% rename from services/library/v1/operations/create-catalog-document/description.md rename to apis/library/v1/operations/create-catalog-document/description.md diff --git a/services/library/v1/operations/create-catalog-document/displayName.md b/apis/library/v1/operations/create-catalog-document/displayName.md similarity index 100% rename from services/library/v1/operations/create-catalog-document/displayName.md rename to apis/library/v1/operations/create-catalog-document/displayName.md diff --git a/services/library/v1/operations/create-catalog-weblink/description.md b/apis/library/v1/operations/create-catalog-weblink/description.md similarity index 100% rename from services/library/v1/operations/create-catalog-weblink/description.md rename to apis/library/v1/operations/create-catalog-weblink/description.md diff --git a/services/library/v1/operations/create-catalog-weblink/displayName.md b/apis/library/v1/operations/create-catalog-weblink/displayName.md similarity index 100% rename from services/library/v1/operations/create-catalog-weblink/displayName.md rename to apis/library/v1/operations/create-catalog-weblink/displayName.md diff --git a/services/library/v1/operations/create-catalog/description.md b/apis/library/v1/operations/create-catalog/description.md similarity index 100% rename from services/library/v1/operations/create-catalog/description.md rename to apis/library/v1/operations/create-catalog/description.md diff --git a/services/library/v1/operations/create-catalog/displayName.md b/apis/library/v1/operations/create-catalog/displayName.md similarity index 100% rename from services/library/v1/operations/create-catalog/displayName.md rename to apis/library/v1/operations/create-catalog/displayName.md diff --git a/services/library/v1/operations/create-category/description.md b/apis/library/v1/operations/create-category/description.md similarity index 100% rename from services/library/v1/operations/create-category/description.md rename to apis/library/v1/operations/create-category/description.md diff --git a/services/library/v1/operations/create-category/displayName.md b/apis/library/v1/operations/create-category/displayName.md similarity index 100% rename from services/library/v1/operations/create-category/displayName.md rename to apis/library/v1/operations/create-category/displayName.md diff --git a/services/library/v1/operations/create-component-document/description.md b/apis/library/v1/operations/create-component-document/description.md similarity index 100% rename from services/library/v1/operations/create-component-document/description.md rename to apis/library/v1/operations/create-component-document/description.md diff --git a/services/library/v1/operations/create-component-document/displayName.md b/apis/library/v1/operations/create-component-document/displayName.md similarity index 100% rename from services/library/v1/operations/create-component-document/displayName.md rename to apis/library/v1/operations/create-component-document/displayName.md diff --git a/services/library/v1/operations/create-component-variation/description.md b/apis/library/v1/operations/create-component-variation/description.md similarity index 100% rename from services/library/v1/operations/create-component-variation/description.md rename to apis/library/v1/operations/create-component-variation/description.md diff --git a/services/library/v1/operations/create-component-variation/displayName.md b/apis/library/v1/operations/create-component-variation/displayName.md similarity index 100% rename from services/library/v1/operations/create-component-variation/displayName.md rename to apis/library/v1/operations/create-component-variation/displayName.md diff --git a/services/library/v1/operations/create-component-weblink/description.md b/apis/library/v1/operations/create-component-weblink/description.md similarity index 100% rename from services/library/v1/operations/create-component-weblink/description.md rename to apis/library/v1/operations/create-component-weblink/description.md diff --git a/services/library/v1/operations/create-component-weblink/displayName.md b/apis/library/v1/operations/create-component-weblink/displayName.md similarity index 100% rename from services/library/v1/operations/create-component-weblink/displayName.md rename to apis/library/v1/operations/create-component-weblink/displayName.md diff --git a/services/library/v1/operations/create-component/description.md b/apis/library/v1/operations/create-component/description.md similarity index 100% rename from services/library/v1/operations/create-component/description.md rename to apis/library/v1/operations/create-component/description.md diff --git a/services/library/v1/operations/create-component/displayName.md b/apis/library/v1/operations/create-component/displayName.md similarity index 100% rename from services/library/v1/operations/create-component/displayName.md rename to apis/library/v1/operations/create-component/displayName.md diff --git a/services/library/v1/operations/create-manufacturer/description.md b/apis/library/v1/operations/create-manufacturer/description.md similarity index 100% rename from services/library/v1/operations/create-manufacturer/description.md rename to apis/library/v1/operations/create-manufacturer/description.md diff --git a/services/library/v1/operations/create-manufacturer/displayName.md b/apis/library/v1/operations/create-manufacturer/displayName.md similarity index 100% rename from services/library/v1/operations/create-manufacturer/displayName.md rename to apis/library/v1/operations/create-manufacturer/displayName.md diff --git a/services/library/v1/operations/delete-application/description.md b/apis/library/v1/operations/delete-application/description.md similarity index 100% rename from services/library/v1/operations/delete-application/description.md rename to apis/library/v1/operations/delete-application/description.md diff --git a/services/library/v1/operations/delete-application/displayName.md b/apis/library/v1/operations/delete-application/displayName.md similarity index 100% rename from services/library/v1/operations/delete-application/displayName.md rename to apis/library/v1/operations/delete-application/displayName.md diff --git a/services/library/v1/operations/delete-catalog-document/description.md b/apis/library/v1/operations/delete-catalog-document/description.md similarity index 100% rename from services/library/v1/operations/delete-catalog-document/description.md rename to apis/library/v1/operations/delete-catalog-document/description.md diff --git a/services/library/v1/operations/delete-catalog-document/displayName.md b/apis/library/v1/operations/delete-catalog-document/displayName.md similarity index 100% rename from services/library/v1/operations/delete-catalog-document/displayName.md rename to apis/library/v1/operations/delete-catalog-document/displayName.md diff --git a/services/library/v1/operations/delete-catalog-weblink/description.md b/apis/library/v1/operations/delete-catalog-weblink/description.md similarity index 100% rename from services/library/v1/operations/delete-catalog-weblink/description.md rename to apis/library/v1/operations/delete-catalog-weblink/description.md diff --git a/services/library/v1/operations/delete-catalog-weblink/displayName.md b/apis/library/v1/operations/delete-catalog-weblink/displayName.md similarity index 100% rename from services/library/v1/operations/delete-catalog-weblink/displayName.md rename to apis/library/v1/operations/delete-catalog-weblink/displayName.md diff --git a/services/library/v1/operations/delete-catalog/description.md b/apis/library/v1/operations/delete-catalog/description.md similarity index 100% rename from services/library/v1/operations/delete-catalog/description.md rename to apis/library/v1/operations/delete-catalog/description.md diff --git a/services/library/v1/operations/delete-catalog/displayName.md b/apis/library/v1/operations/delete-catalog/displayName.md similarity index 100% rename from services/library/v1/operations/delete-catalog/displayName.md rename to apis/library/v1/operations/delete-catalog/displayName.md diff --git a/services/library/v1/operations/delete-category/description.md b/apis/library/v1/operations/delete-category/description.md similarity index 100% rename from services/library/v1/operations/delete-category/description.md rename to apis/library/v1/operations/delete-category/description.md diff --git a/services/library/v1/operations/delete-category/displayName.md b/apis/library/v1/operations/delete-category/displayName.md similarity index 100% rename from services/library/v1/operations/delete-category/displayName.md rename to apis/library/v1/operations/delete-category/displayName.md diff --git a/services/library/v1/operations/delete-component-document/description.md b/apis/library/v1/operations/delete-component-document/description.md similarity index 100% rename from services/library/v1/operations/delete-component-document/description.md rename to apis/library/v1/operations/delete-component-document/description.md diff --git a/services/library/v1/operations/delete-component-document/displayName.md b/apis/library/v1/operations/delete-component-document/displayName.md similarity index 100% rename from services/library/v1/operations/delete-component-document/displayName.md rename to apis/library/v1/operations/delete-component-document/displayName.md diff --git a/services/library/v1/operations/delete-component-variation/description.md b/apis/library/v1/operations/delete-component-variation/description.md similarity index 100% rename from services/library/v1/operations/delete-component-variation/description.md rename to apis/library/v1/operations/delete-component-variation/description.md diff --git a/services/library/v1/operations/delete-component-variation/displayName.md b/apis/library/v1/operations/delete-component-variation/displayName.md similarity index 100% rename from services/library/v1/operations/delete-component-variation/displayName.md rename to apis/library/v1/operations/delete-component-variation/displayName.md diff --git a/services/library/v1/operations/delete-component-weblink/description.md b/apis/library/v1/operations/delete-component-weblink/description.md similarity index 100% rename from services/library/v1/operations/delete-component-weblink/description.md rename to apis/library/v1/operations/delete-component-weblink/description.md diff --git a/services/library/v1/operations/delete-component-weblink/displayName.md b/apis/library/v1/operations/delete-component-weblink/displayName.md similarity index 100% rename from services/library/v1/operations/delete-component-weblink/displayName.md rename to apis/library/v1/operations/delete-component-weblink/displayName.md diff --git a/services/library/v1/operations/delete-component/description.md b/apis/library/v1/operations/delete-component/description.md similarity index 100% rename from services/library/v1/operations/delete-component/description.md rename to apis/library/v1/operations/delete-component/description.md diff --git a/services/library/v1/operations/delete-component/displayName.md b/apis/library/v1/operations/delete-component/displayName.md similarity index 100% rename from services/library/v1/operations/delete-component/displayName.md rename to apis/library/v1/operations/delete-component/displayName.md diff --git a/services/library/v1/operations/delete-manufacturer/description.md b/apis/library/v1/operations/delete-manufacturer/description.md similarity index 100% rename from services/library/v1/operations/delete-manufacturer/description.md rename to apis/library/v1/operations/delete-manufacturer/description.md diff --git a/services/library/v1/operations/delete-manufacturer/displayName.md b/apis/library/v1/operations/delete-manufacturer/displayName.md similarity index 100% rename from services/library/v1/operations/delete-manufacturer/displayName.md rename to apis/library/v1/operations/delete-manufacturer/displayName.md diff --git a/services/library/v1/operations/download-analytics/description.md b/apis/library/v1/operations/download-analytics/description.md similarity index 100% rename from services/library/v1/operations/download-analytics/description.md rename to apis/library/v1/operations/download-analytics/description.md diff --git a/services/library/v1/operations/download-analytics/displayName.md b/apis/library/v1/operations/download-analytics/displayName.md similarity index 100% rename from services/library/v1/operations/download-analytics/displayName.md rename to apis/library/v1/operations/download-analytics/displayName.md diff --git a/services/library/v1/operations/get-application/description.md b/apis/library/v1/operations/get-application/description.md similarity index 100% rename from services/library/v1/operations/get-application/description.md rename to apis/library/v1/operations/get-application/description.md diff --git a/services/library/v1/operations/get-application/displayName.md b/apis/library/v1/operations/get-application/displayName.md similarity index 100% rename from services/library/v1/operations/get-application/displayName.md rename to apis/library/v1/operations/get-application/displayName.md diff --git a/services/library/v1/operations/get-applications/description.md b/apis/library/v1/operations/get-applications/description.md similarity index 100% rename from services/library/v1/operations/get-applications/description.md rename to apis/library/v1/operations/get-applications/description.md diff --git a/services/library/v1/operations/get-applications/displayName.md b/apis/library/v1/operations/get-applications/displayName.md similarity index 100% rename from services/library/v1/operations/get-applications/displayName.md rename to apis/library/v1/operations/get-applications/displayName.md diff --git a/services/library/v1/operations/get-brand-component-documents/description.md b/apis/library/v1/operations/get-brand-component-documents/description.md similarity index 100% rename from services/library/v1/operations/get-brand-component-documents/description.md rename to apis/library/v1/operations/get-brand-component-documents/description.md diff --git a/services/library/v1/operations/get-brand-component-documents/displayName.md b/apis/library/v1/operations/get-brand-component-documents/displayName.md similarity index 100% rename from services/library/v1/operations/get-brand-component-documents/displayName.md rename to apis/library/v1/operations/get-brand-component-documents/displayName.md diff --git a/services/library/v1/operations/get-brand-component-variations/description.md b/apis/library/v1/operations/get-brand-component-variations/description.md similarity index 100% rename from services/library/v1/operations/get-brand-component-variations/description.md rename to apis/library/v1/operations/get-brand-component-variations/description.md diff --git a/services/library/v1/operations/get-brand-component-variations/displayName.md b/apis/library/v1/operations/get-brand-component-variations/displayName.md similarity index 100% rename from services/library/v1/operations/get-brand-component-variations/displayName.md rename to apis/library/v1/operations/get-brand-component-variations/displayName.md diff --git a/services/library/v1/operations/get-brand-component-weblinks/description.md b/apis/library/v1/operations/get-brand-component-weblinks/description.md similarity index 100% rename from services/library/v1/operations/get-brand-component-weblinks/description.md rename to apis/library/v1/operations/get-brand-component-weblinks/description.md diff --git a/services/library/v1/operations/get-brand-component-weblinks/displayName.md b/apis/library/v1/operations/get-brand-component-weblinks/displayName.md similarity index 100% rename from services/library/v1/operations/get-brand-component-weblinks/displayName.md rename to apis/library/v1/operations/get-brand-component-weblinks/displayName.md diff --git a/services/library/v1/operations/get-brand-components/description.md b/apis/library/v1/operations/get-brand-components/description.md similarity index 100% rename from services/library/v1/operations/get-brand-components/description.md rename to apis/library/v1/operations/get-brand-components/description.md diff --git a/services/library/v1/operations/get-brand-components/displayName.md b/apis/library/v1/operations/get-brand-components/displayName.md similarity index 100% rename from services/library/v1/operations/get-brand-components/displayName.md rename to apis/library/v1/operations/get-brand-components/displayName.md diff --git a/services/library/v1/operations/get-brand/description.md b/apis/library/v1/operations/get-brand/description.md similarity index 100% rename from services/library/v1/operations/get-brand/description.md rename to apis/library/v1/operations/get-brand/description.md diff --git a/services/library/v1/operations/get-brand/displayName.md b/apis/library/v1/operations/get-brand/displayName.md similarity index 100% rename from services/library/v1/operations/get-brand/displayName.md rename to apis/library/v1/operations/get-brand/displayName.md diff --git a/services/library/v1/operations/get-brands/description.md b/apis/library/v1/operations/get-brands/description.md similarity index 100% rename from services/library/v1/operations/get-brands/description.md rename to apis/library/v1/operations/get-brands/description.md diff --git a/services/library/v1/operations/get-brands/displayName.md b/apis/library/v1/operations/get-brands/displayName.md similarity index 100% rename from services/library/v1/operations/get-brands/displayName.md rename to apis/library/v1/operations/get-brands/displayName.md diff --git a/services/library/v1/operations/get-catalog-document/description.md b/apis/library/v1/operations/get-catalog-document/description.md similarity index 100% rename from services/library/v1/operations/get-catalog-document/description.md rename to apis/library/v1/operations/get-catalog-document/description.md diff --git a/services/library/v1/operations/get-catalog-document/displayName.md b/apis/library/v1/operations/get-catalog-document/displayName.md similarity index 100% rename from services/library/v1/operations/get-catalog-document/displayName.md rename to apis/library/v1/operations/get-catalog-document/displayName.md diff --git a/services/library/v1/operations/get-catalog-documents/description.md b/apis/library/v1/operations/get-catalog-documents/description.md similarity index 100% rename from services/library/v1/operations/get-catalog-documents/description.md rename to apis/library/v1/operations/get-catalog-documents/description.md diff --git a/services/library/v1/operations/get-catalog-documents/displayName.md b/apis/library/v1/operations/get-catalog-documents/displayName.md similarity index 100% rename from services/library/v1/operations/get-catalog-documents/displayName.md rename to apis/library/v1/operations/get-catalog-documents/displayName.md diff --git a/services/library/v1/operations/get-catalog-weblink/description.md b/apis/library/v1/operations/get-catalog-weblink/description.md similarity index 100% rename from services/library/v1/operations/get-catalog-weblink/description.md rename to apis/library/v1/operations/get-catalog-weblink/description.md diff --git a/services/library/v1/operations/get-catalog-weblink/displayName.md b/apis/library/v1/operations/get-catalog-weblink/displayName.md similarity index 100% rename from services/library/v1/operations/get-catalog-weblink/displayName.md rename to apis/library/v1/operations/get-catalog-weblink/displayName.md diff --git a/services/library/v1/operations/get-catalog-weblinks/description.md b/apis/library/v1/operations/get-catalog-weblinks/description.md similarity index 100% rename from services/library/v1/operations/get-catalog-weblinks/description.md rename to apis/library/v1/operations/get-catalog-weblinks/description.md diff --git a/services/library/v1/operations/get-catalog-weblinks/displayName.md b/apis/library/v1/operations/get-catalog-weblinks/displayName.md similarity index 100% rename from services/library/v1/operations/get-catalog-weblinks/displayName.md rename to apis/library/v1/operations/get-catalog-weblinks/displayName.md diff --git a/services/library/v1/operations/get-catalog/description.md b/apis/library/v1/operations/get-catalog/description.md similarity index 100% rename from services/library/v1/operations/get-catalog/description.md rename to apis/library/v1/operations/get-catalog/description.md diff --git a/services/library/v1/operations/get-catalog/displayName.md b/apis/library/v1/operations/get-catalog/displayName.md similarity index 100% rename from services/library/v1/operations/get-catalog/displayName.md rename to apis/library/v1/operations/get-catalog/displayName.md diff --git a/services/library/v1/operations/get-catalogs/description.md b/apis/library/v1/operations/get-catalogs/description.md similarity index 100% rename from services/library/v1/operations/get-catalogs/description.md rename to apis/library/v1/operations/get-catalogs/description.md diff --git a/services/library/v1/operations/get-catalogs/displayName.md b/apis/library/v1/operations/get-catalogs/displayName.md similarity index 100% rename from services/library/v1/operations/get-catalogs/displayName.md rename to apis/library/v1/operations/get-catalogs/displayName.md diff --git a/services/library/v1/operations/get-categories/description.md b/apis/library/v1/operations/get-categories/description.md similarity index 100% rename from services/library/v1/operations/get-categories/description.md rename to apis/library/v1/operations/get-categories/description.md diff --git a/services/library/v1/operations/get-categories/displayName.md b/apis/library/v1/operations/get-categories/displayName.md similarity index 100% rename from services/library/v1/operations/get-categories/displayName.md rename to apis/library/v1/operations/get-categories/displayName.md diff --git a/services/library/v1/operations/get-category/description.md b/apis/library/v1/operations/get-category/description.md similarity index 100% rename from services/library/v1/operations/get-category/description.md rename to apis/library/v1/operations/get-category/description.md diff --git a/services/library/v1/operations/get-category/displayName.md b/apis/library/v1/operations/get-category/displayName.md similarity index 100% rename from services/library/v1/operations/get-category/displayName.md rename to apis/library/v1/operations/get-category/displayName.md diff --git a/services/library/v1/operations/get-component-document/description.md b/apis/library/v1/operations/get-component-document/description.md similarity index 100% rename from services/library/v1/operations/get-component-document/description.md rename to apis/library/v1/operations/get-component-document/description.md diff --git a/services/library/v1/operations/get-component-document/displayName.md b/apis/library/v1/operations/get-component-document/displayName.md similarity index 100% rename from services/library/v1/operations/get-component-document/displayName.md rename to apis/library/v1/operations/get-component-document/displayName.md diff --git a/services/library/v1/operations/get-component-documents/description.md b/apis/library/v1/operations/get-component-documents/description.md similarity index 100% rename from services/library/v1/operations/get-component-documents/description.md rename to apis/library/v1/operations/get-component-documents/description.md diff --git a/services/library/v1/operations/get-component-documents/displayName.md b/apis/library/v1/operations/get-component-documents/displayName.md similarity index 100% rename from services/library/v1/operations/get-component-documents/displayName.md rename to apis/library/v1/operations/get-component-documents/displayName.md diff --git a/services/library/v1/operations/get-component-variation/description.md b/apis/library/v1/operations/get-component-variation/description.md similarity index 100% rename from services/library/v1/operations/get-component-variation/description.md rename to apis/library/v1/operations/get-component-variation/description.md diff --git a/services/library/v1/operations/get-component-variation/displayName.md b/apis/library/v1/operations/get-component-variation/displayName.md similarity index 100% rename from services/library/v1/operations/get-component-variation/displayName.md rename to apis/library/v1/operations/get-component-variation/displayName.md diff --git a/services/library/v1/operations/get-component-variations/description.md b/apis/library/v1/operations/get-component-variations/description.md similarity index 100% rename from services/library/v1/operations/get-component-variations/description.md rename to apis/library/v1/operations/get-component-variations/description.md diff --git a/services/library/v1/operations/get-component-variations/displayName.md b/apis/library/v1/operations/get-component-variations/displayName.md similarity index 100% rename from services/library/v1/operations/get-component-variations/displayName.md rename to apis/library/v1/operations/get-component-variations/displayName.md diff --git a/services/library/v1/operations/get-component-weblink/description.md b/apis/library/v1/operations/get-component-weblink/description.md similarity index 100% rename from services/library/v1/operations/get-component-weblink/description.md rename to apis/library/v1/operations/get-component-weblink/description.md diff --git a/services/library/v1/operations/get-component-weblink/displayName.md b/apis/library/v1/operations/get-component-weblink/displayName.md similarity index 100% rename from services/library/v1/operations/get-component-weblink/displayName.md rename to apis/library/v1/operations/get-component-weblink/displayName.md diff --git a/services/library/v1/operations/get-component-weblinks/description.md b/apis/library/v1/operations/get-component-weblinks/description.md similarity index 100% rename from services/library/v1/operations/get-component-weblinks/description.md rename to apis/library/v1/operations/get-component-weblinks/description.md diff --git a/services/library/v1/operations/get-component-weblinks/displayName.md b/apis/library/v1/operations/get-component-weblinks/displayName.md similarity index 100% rename from services/library/v1/operations/get-component-weblinks/displayName.md rename to apis/library/v1/operations/get-component-weblinks/displayName.md diff --git a/services/library/v1/operations/get-component/description.md b/apis/library/v1/operations/get-component/description.md similarity index 100% rename from services/library/v1/operations/get-component/description.md rename to apis/library/v1/operations/get-component/description.md diff --git a/services/library/v1/operations/get-component/displayName.md b/apis/library/v1/operations/get-component/displayName.md similarity index 100% rename from services/library/v1/operations/get-component/displayName.md rename to apis/library/v1/operations/get-component/displayName.md diff --git a/services/library/v1/operations/get-components/description.md b/apis/library/v1/operations/get-components/description.md similarity index 100% rename from services/library/v1/operations/get-components/description.md rename to apis/library/v1/operations/get-components/description.md diff --git a/services/library/v1/operations/get-components/displayName.md b/apis/library/v1/operations/get-components/displayName.md similarity index 100% rename from services/library/v1/operations/get-components/displayName.md rename to apis/library/v1/operations/get-components/displayName.md diff --git a/services/library/v1/operations/get-job/description.md b/apis/library/v1/operations/get-job/description.md similarity index 100% rename from services/library/v1/operations/get-job/description.md rename to apis/library/v1/operations/get-job/description.md diff --git a/services/library/v1/operations/get-job/displayName.md b/apis/library/v1/operations/get-job/displayName.md similarity index 100% rename from services/library/v1/operations/get-job/displayName.md rename to apis/library/v1/operations/get-job/displayName.md diff --git a/services/library/v1/operations/get-manufacturer/description.md b/apis/library/v1/operations/get-manufacturer/description.md similarity index 100% rename from services/library/v1/operations/get-manufacturer/description.md rename to apis/library/v1/operations/get-manufacturer/description.md diff --git a/services/library/v1/operations/get-manufacturer/displayName.md b/apis/library/v1/operations/get-manufacturer/displayName.md similarity index 100% rename from services/library/v1/operations/get-manufacturer/displayName.md rename to apis/library/v1/operations/get-manufacturer/displayName.md diff --git a/services/library/v1/operations/get-manufacturers/description.md b/apis/library/v1/operations/get-manufacturers/description.md similarity index 100% rename from services/library/v1/operations/get-manufacturers/description.md rename to apis/library/v1/operations/get-manufacturers/description.md diff --git a/services/library/v1/operations/get-manufacturers/displayName.md b/apis/library/v1/operations/get-manufacturers/displayName.md similarity index 100% rename from services/library/v1/operations/get-manufacturers/displayName.md rename to apis/library/v1/operations/get-manufacturers/displayName.md diff --git a/services/library/v1/operations/update-application/description.md b/apis/library/v1/operations/update-application/description.md similarity index 100% rename from services/library/v1/operations/update-application/description.md rename to apis/library/v1/operations/update-application/description.md diff --git a/services/library/v1/operations/update-application/displayName.md b/apis/library/v1/operations/update-application/displayName.md similarity index 100% rename from services/library/v1/operations/update-application/displayName.md rename to apis/library/v1/operations/update-application/displayName.md diff --git a/services/library/v1/operations/update-catalog-document/description.md b/apis/library/v1/operations/update-catalog-document/description.md similarity index 100% rename from services/library/v1/operations/update-catalog-document/description.md rename to apis/library/v1/operations/update-catalog-document/description.md diff --git a/services/library/v1/operations/update-catalog-document/displayName.md b/apis/library/v1/operations/update-catalog-document/displayName.md similarity index 100% rename from services/library/v1/operations/update-catalog-document/displayName.md rename to apis/library/v1/operations/update-catalog-document/displayName.md diff --git a/services/library/v1/operations/update-catalog-weblink/description.md b/apis/library/v1/operations/update-catalog-weblink/description.md similarity index 100% rename from services/library/v1/operations/update-catalog-weblink/description.md rename to apis/library/v1/operations/update-catalog-weblink/description.md diff --git a/services/library/v1/operations/update-catalog-weblink/displayName.md b/apis/library/v1/operations/update-catalog-weblink/displayName.md similarity index 100% rename from services/library/v1/operations/update-catalog-weblink/displayName.md rename to apis/library/v1/operations/update-catalog-weblink/displayName.md diff --git a/services/library/v1/operations/update-catalog/description.md b/apis/library/v1/operations/update-catalog/description.md similarity index 100% rename from services/library/v1/operations/update-catalog/description.md rename to apis/library/v1/operations/update-catalog/description.md diff --git a/services/library/v1/operations/update-catalog/displayName.md b/apis/library/v1/operations/update-catalog/displayName.md similarity index 100% rename from services/library/v1/operations/update-catalog/displayName.md rename to apis/library/v1/operations/update-catalog/displayName.md diff --git a/services/library/v1/operations/update-category/description.md b/apis/library/v1/operations/update-category/description.md similarity index 100% rename from services/library/v1/operations/update-category/description.md rename to apis/library/v1/operations/update-category/description.md diff --git a/services/library/v1/operations/update-category/displayName.md b/apis/library/v1/operations/update-category/displayName.md similarity index 100% rename from services/library/v1/operations/update-category/displayName.md rename to apis/library/v1/operations/update-category/displayName.md diff --git a/services/library/v1/operations/update-component-document/description.md b/apis/library/v1/operations/update-component-document/description.md similarity index 100% rename from services/library/v1/operations/update-component-document/description.md rename to apis/library/v1/operations/update-component-document/description.md diff --git a/services/library/v1/operations/update-component-document/displayName.md b/apis/library/v1/operations/update-component-document/displayName.md similarity index 100% rename from services/library/v1/operations/update-component-document/displayName.md rename to apis/library/v1/operations/update-component-document/displayName.md diff --git a/services/library/v1/operations/update-component-variation/description.md b/apis/library/v1/operations/update-component-variation/description.md similarity index 100% rename from services/library/v1/operations/update-component-variation/description.md rename to apis/library/v1/operations/update-component-variation/description.md diff --git a/services/library/v1/operations/update-component-variation/displayName.md b/apis/library/v1/operations/update-component-variation/displayName.md similarity index 100% rename from services/library/v1/operations/update-component-variation/displayName.md rename to apis/library/v1/operations/update-component-variation/displayName.md diff --git a/services/library/v1/operations/update-component-weblink/description.md b/apis/library/v1/operations/update-component-weblink/description.md similarity index 100% rename from services/library/v1/operations/update-component-weblink/description.md rename to apis/library/v1/operations/update-component-weblink/description.md diff --git a/services/library/v1/operations/update-component-weblink/displayName.md b/apis/library/v1/operations/update-component-weblink/displayName.md similarity index 100% rename from services/library/v1/operations/update-component-weblink/displayName.md rename to apis/library/v1/operations/update-component-weblink/displayName.md diff --git a/services/library/v1/operations/update-component/description.md b/apis/library/v1/operations/update-component/description.md similarity index 100% rename from services/library/v1/operations/update-component/description.md rename to apis/library/v1/operations/update-component/description.md diff --git a/services/library/v1/operations/update-component/displayName.md b/apis/library/v1/operations/update-component/displayName.md similarity index 100% rename from services/library/v1/operations/update-component/displayName.md rename to apis/library/v1/operations/update-component/displayName.md diff --git a/services/library/v1/operations/update-manufacturer/description.md b/apis/library/v1/operations/update-manufacturer/description.md similarity index 100% rename from services/library/v1/operations/update-manufacturer/description.md rename to apis/library/v1/operations/update-manufacturer/description.md diff --git a/services/library/v1/operations/update-manufacturer/displayName.md b/apis/library/v1/operations/update-manufacturer/displayName.md similarity index 100% rename from services/library/v1/operations/update-manufacturer/displayName.md rename to apis/library/v1/operations/update-manufacturer/displayName.md diff --git a/services/library/v1/operations/upload-component/description.md b/apis/library/v1/operations/upload-component/description.md similarity index 100% rename from services/library/v1/operations/upload-component/description.md rename to apis/library/v1/operations/upload-component/description.md diff --git a/services/library/v1/operations/upload-component/displayName.md b/apis/library/v1/operations/upload-component/displayName.md similarity index 100% rename from services/library/v1/operations/upload-component/displayName.md rename to apis/library/v1/operations/upload-component/displayName.md diff --git a/services/mesh-export/v1/description.md b/apis/mesh-export/v1/description.md similarity index 100% rename from services/mesh-export/v1/description.md rename to apis/mesh-export/v1/description.md diff --git a/services/mesh-export/v1/operations/delete-export/description.md b/apis/mesh-export/v1/operations/delete-export/description.md similarity index 100% rename from services/mesh-export/v1/operations/delete-export/description.md rename to apis/mesh-export/v1/operations/delete-export/description.md diff --git a/services/mesh-export/v1/operations/delete-export/displayName.md b/apis/mesh-export/v1/operations/delete-export/displayName.md similarity index 100% rename from services/mesh-export/v1/operations/delete-export/displayName.md rename to apis/mesh-export/v1/operations/delete-export/displayName.md diff --git a/services/mesh-export/v1/operations/get-export/description.md b/apis/mesh-export/v1/operations/get-export/description.md similarity index 100% rename from services/mesh-export/v1/operations/get-export/description.md rename to apis/mesh-export/v1/operations/get-export/description.md diff --git a/services/mesh-export/v1/operations/get-export/displayName.md b/apis/mesh-export/v1/operations/get-export/displayName.md similarity index 100% rename from services/mesh-export/v1/operations/get-export/displayName.md rename to apis/mesh-export/v1/operations/get-export/displayName.md diff --git a/services/mesh-export/v1/operations/get-exports/description.md b/apis/mesh-export/v1/operations/get-exports/description.md similarity index 100% rename from services/mesh-export/v1/operations/get-exports/description.md rename to apis/mesh-export/v1/operations/get-exports/description.md diff --git a/services/mesh-export/v1/operations/get-exports/displayName.md b/apis/mesh-export/v1/operations/get-exports/displayName.md similarity index 100% rename from services/mesh-export/v1/operations/get-exports/displayName.md rename to apis/mesh-export/v1/operations/get-exports/displayName.md diff --git a/services/mesh-export/v1/operations/start-export/description.md b/apis/mesh-export/v1/operations/start-export/description.md similarity index 100% rename from services/mesh-export/v1/operations/start-export/description.md rename to apis/mesh-export/v1/operations/start-export/description.md diff --git a/services/mesh-export/v1/operations/start-export/displayName.md b/apis/mesh-export/v1/operations/start-export/displayName.md similarity index 100% rename from services/mesh-export/v1/operations/start-export/displayName.md rename to apis/mesh-export/v1/operations/start-export/displayName.md diff --git a/services/named-groups/v1/operations/create-group/description.md b/apis/named-groups/v1/operations/create-group/description.md similarity index 100% rename from services/named-groups/v1/operations/create-group/description.md rename to apis/named-groups/v1/operations/create-group/description.md diff --git a/services/named-groups/v1/operations/create-group/displayName.md b/apis/named-groups/v1/operations/create-group/displayName.md similarity index 100% rename from services/named-groups/v1/operations/create-group/displayName.md rename to apis/named-groups/v1/operations/create-group/displayName.md diff --git a/services/named-groups/v1/operations/delete-group/description.md b/apis/named-groups/v1/operations/delete-group/description.md similarity index 100% rename from services/named-groups/v1/operations/delete-group/description.md rename to apis/named-groups/v1/operations/delete-group/description.md diff --git a/services/named-groups/v1/operations/delete-group/displayName.md b/apis/named-groups/v1/operations/delete-group/displayName.md similarity index 100% rename from services/named-groups/v1/operations/delete-group/displayName.md rename to apis/named-groups/v1/operations/delete-group/displayName.md diff --git a/services/named-groups/v1/operations/get-group/description.md b/apis/named-groups/v1/operations/get-group/description.md similarity index 100% rename from services/named-groups/v1/operations/get-group/description.md rename to apis/named-groups/v1/operations/get-group/description.md diff --git a/services/named-groups/v1/operations/get-group/displayName.md b/apis/named-groups/v1/operations/get-group/displayName.md similarity index 100% rename from services/named-groups/v1/operations/get-group/displayName.md rename to apis/named-groups/v1/operations/get-group/displayName.md diff --git a/services/named-groups/v1/operations/get-itwin-groups/description.md b/apis/named-groups/v1/operations/get-itwin-groups/description.md similarity index 100% rename from services/named-groups/v1/operations/get-itwin-groups/description.md rename to apis/named-groups/v1/operations/get-itwin-groups/description.md diff --git a/services/named-groups/v1/operations/get-itwin-groups/displayName.md b/apis/named-groups/v1/operations/get-itwin-groups/displayName.md similarity index 100% rename from services/named-groups/v1/operations/get-itwin-groups/displayName.md rename to apis/named-groups/v1/operations/get-itwin-groups/displayName.md diff --git a/services/named-groups/v1/operations/update-group/description.md b/apis/named-groups/v1/operations/update-group/description.md similarity index 100% rename from services/named-groups/v1/operations/update-group/description.md rename to apis/named-groups/v1/operations/update-group/description.md diff --git a/services/named-groups/v1/operations/update-group/displayName.md b/apis/named-groups/v1/operations/update-group/displayName.md similarity index 100% rename from services/named-groups/v1/operations/update-group/displayName.md rename to apis/named-groups/v1/operations/update-group/displayName.md diff --git a/services/pnid-to-itwin/v2/description.md b/apis/pnid-to-itwin/v2/description.md similarity index 100% rename from services/pnid-to-itwin/v2/description.md rename to apis/pnid-to-itwin/v2/description.md diff --git a/services/pnid-to-itwin/v2/operations/create-inference-run/description.md b/apis/pnid-to-itwin/v2/operations/create-inference-run/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/create-inference-run/description.md rename to apis/pnid-to-itwin/v2/operations/create-inference-run/description.md diff --git a/services/pnid-to-itwin/v2/operations/create-inference-run/displayName.md b/apis/pnid-to-itwin/v2/operations/create-inference-run/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/create-inference-run/displayName.md rename to apis/pnid-to-itwin/v2/operations/create-inference-run/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/create-inference/description.md b/apis/pnid-to-itwin/v2/operations/create-inference/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/create-inference/description.md rename to apis/pnid-to-itwin/v2/operations/create-inference/description.md diff --git a/services/pnid-to-itwin/v2/operations/create-inference/displayName.md b/apis/pnid-to-itwin/v2/operations/create-inference/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/create-inference/displayName.md rename to apis/pnid-to-itwin/v2/operations/create-inference/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/delete-inference-input/description.md b/apis/pnid-to-itwin/v2/operations/delete-inference-input/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/delete-inference-input/description.md rename to apis/pnid-to-itwin/v2/operations/delete-inference-input/description.md diff --git a/services/pnid-to-itwin/v2/operations/delete-inference-input/displayName.md b/apis/pnid-to-itwin/v2/operations/delete-inference-input/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/delete-inference-input/displayName.md rename to apis/pnid-to-itwin/v2/operations/delete-inference-input/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/delete-inference-run/description.md b/apis/pnid-to-itwin/v2/operations/delete-inference-run/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/delete-inference-run/description.md rename to apis/pnid-to-itwin/v2/operations/delete-inference-run/description.md diff --git a/services/pnid-to-itwin/v2/operations/delete-inference-run/displayName.md b/apis/pnid-to-itwin/v2/operations/delete-inference-run/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/delete-inference-run/displayName.md rename to apis/pnid-to-itwin/v2/operations/delete-inference-run/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/delete-inference/description.md b/apis/pnid-to-itwin/v2/operations/delete-inference/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/delete-inference/description.md rename to apis/pnid-to-itwin/v2/operations/delete-inference/description.md diff --git a/services/pnid-to-itwin/v2/operations/delete-inference/displayName.md b/apis/pnid-to-itwin/v2/operations/delete-inference/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/delete-inference/displayName.md rename to apis/pnid-to-itwin/v2/operations/delete-inference/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference-input-content/description.md b/apis/pnid-to-itwin/v2/operations/get-inference-input-content/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference-input-content/description.md rename to apis/pnid-to-itwin/v2/operations/get-inference-input-content/description.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference-input-content/displayName.md b/apis/pnid-to-itwin/v2/operations/get-inference-input-content/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference-input-content/displayName.md rename to apis/pnid-to-itwin/v2/operations/get-inference-input-content/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference-inputs/description.md b/apis/pnid-to-itwin/v2/operations/get-inference-inputs/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference-inputs/description.md rename to apis/pnid-to-itwin/v2/operations/get-inference-inputs/description.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference-inputs/displayName.md b/apis/pnid-to-itwin/v2/operations/get-inference-inputs/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference-inputs/displayName.md rename to apis/pnid-to-itwin/v2/operations/get-inference-inputs/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run-result-content/description.md b/apis/pnid-to-itwin/v2/operations/get-inference-run-result-content/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference-run-result-content/description.md rename to apis/pnid-to-itwin/v2/operations/get-inference-run-result-content/description.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run-result-content/displayName.md b/apis/pnid-to-itwin/v2/operations/get-inference-run-result-content/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference-run-result-content/displayName.md rename to apis/pnid-to-itwin/v2/operations/get-inference-run-result-content/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run-results/description.md b/apis/pnid-to-itwin/v2/operations/get-inference-run-results/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference-run-results/description.md rename to apis/pnid-to-itwin/v2/operations/get-inference-run-results/description.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run-results/displayName.md b/apis/pnid-to-itwin/v2/operations/get-inference-run-results/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference-run-results/displayName.md rename to apis/pnid-to-itwin/v2/operations/get-inference-run-results/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run/description.md b/apis/pnid-to-itwin/v2/operations/get-inference-run/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference-run/description.md rename to apis/pnid-to-itwin/v2/operations/get-inference-run/description.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference-run/displayName.md b/apis/pnid-to-itwin/v2/operations/get-inference-run/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference-run/displayName.md rename to apis/pnid-to-itwin/v2/operations/get-inference-run/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference/description.md b/apis/pnid-to-itwin/v2/operations/get-inference/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference/description.md rename to apis/pnid-to-itwin/v2/operations/get-inference/description.md diff --git a/services/pnid-to-itwin/v2/operations/get-inference/displayName.md b/apis/pnid-to-itwin/v2/operations/get-inference/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-inference/displayName.md rename to apis/pnid-to-itwin/v2/operations/get-inference/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/get-itwin-inferences/description.md b/apis/pnid-to-itwin/v2/operations/get-itwin-inferences/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-itwin-inferences/description.md rename to apis/pnid-to-itwin/v2/operations/get-itwin-inferences/description.md diff --git a/services/pnid-to-itwin/v2/operations/get-itwin-inferences/displayName.md b/apis/pnid-to-itwin/v2/operations/get-itwin-inferences/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/get-itwin-inferences/displayName.md rename to apis/pnid-to-itwin/v2/operations/get-itwin-inferences/displayName.md diff --git a/services/pnid-to-itwin/v2/operations/upload-inference-input-content/description.md b/apis/pnid-to-itwin/v2/operations/upload-inference-input-content/description.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/upload-inference-input-content/description.md rename to apis/pnid-to-itwin/v2/operations/upload-inference-input-content/description.md diff --git a/services/pnid-to-itwin/v2/operations/upload-inference-input-content/displayName.md b/apis/pnid-to-itwin/v2/operations/upload-inference-input-content/displayName.md similarity index 100% rename from services/pnid-to-itwin/v2/operations/upload-inference-input-content/displayName.md rename to apis/pnid-to-itwin/v2/operations/upload-inference-input-content/displayName.md diff --git a/services/projects/v1/description.md b/apis/projects/v1/description.md similarity index 100% rename from services/projects/v1/description.md rename to apis/projects/v1/description.md diff --git a/services/projects/v1/operations/add-project-team-member/description.md b/apis/projects/v1/operations/add-project-team-member/description.md similarity index 100% rename from services/projects/v1/operations/add-project-team-member/description.md rename to apis/projects/v1/operations/add-project-team-member/description.md diff --git a/services/projects/v1/operations/add-project-team-member/displayName.md b/apis/projects/v1/operations/add-project-team-member/displayName.md similarity index 100% rename from services/projects/v1/operations/add-project-team-member/displayName.md rename to apis/projects/v1/operations/add-project-team-member/displayName.md diff --git a/services/projects/v1/operations/add-project-to-my-favorites/description.md b/apis/projects/v1/operations/add-project-to-my-favorites/description.md similarity index 100% rename from services/projects/v1/operations/add-project-to-my-favorites/description.md rename to apis/projects/v1/operations/add-project-to-my-favorites/description.md diff --git a/services/projects/v1/operations/add-project-to-my-favorites/displayName.md b/apis/projects/v1/operations/add-project-to-my-favorites/displayName.md similarity index 100% rename from services/projects/v1/operations/add-project-to-my-favorites/displayName.md rename to apis/projects/v1/operations/add-project-to-my-favorites/displayName.md diff --git a/services/projects/v1/operations/add-project-to-my-recents/description.md b/apis/projects/v1/operations/add-project-to-my-recents/description.md similarity index 100% rename from services/projects/v1/operations/add-project-to-my-recents/description.md rename to apis/projects/v1/operations/add-project-to-my-recents/description.md diff --git a/services/projects/v1/operations/add-project-to-my-recents/displayName.md b/apis/projects/v1/operations/add-project-to-my-recents/displayName.md similarity index 100% rename from services/projects/v1/operations/add-project-to-my-recents/displayName.md rename to apis/projects/v1/operations/add-project-to-my-recents/displayName.md diff --git a/services/projects/v1/operations/create-project-role/description.md b/apis/projects/v1/operations/create-project-role/description.md similarity index 100% rename from services/projects/v1/operations/create-project-role/description.md rename to apis/projects/v1/operations/create-project-role/description.md diff --git a/services/projects/v1/operations/create-project-role/displayName.md b/apis/projects/v1/operations/create-project-role/displayName.md similarity index 100% rename from services/projects/v1/operations/create-project-role/displayName.md rename to apis/projects/v1/operations/create-project-role/displayName.md diff --git a/services/projects/v1/operations/create-project/description.md b/apis/projects/v1/operations/create-project/description.md similarity index 100% rename from services/projects/v1/operations/create-project/description.md rename to apis/projects/v1/operations/create-project/description.md diff --git a/services/projects/v1/operations/create-project/displayName.md b/apis/projects/v1/operations/create-project/displayName.md similarity index 100% rename from services/projects/v1/operations/create-project/displayName.md rename to apis/projects/v1/operations/create-project/displayName.md diff --git a/services/projects/v1/operations/delete-project-role/description.md b/apis/projects/v1/operations/delete-project-role/description.md similarity index 100% rename from services/projects/v1/operations/delete-project-role/description.md rename to apis/projects/v1/operations/delete-project-role/description.md diff --git a/services/projects/v1/operations/delete-project-role/displayName.md b/apis/projects/v1/operations/delete-project-role/displayName.md similarity index 100% rename from services/projects/v1/operations/delete-project-role/displayName.md rename to apis/projects/v1/operations/delete-project-role/displayName.md diff --git a/services/projects/v1/operations/delete-project/description.md b/apis/projects/v1/operations/delete-project/description.md similarity index 100% rename from services/projects/v1/operations/delete-project/description.md rename to apis/projects/v1/operations/delete-project/description.md diff --git a/services/projects/v1/operations/delete-project/displayName.md b/apis/projects/v1/operations/delete-project/displayName.md similarity index 100% rename from services/projects/v1/operations/delete-project/displayName.md rename to apis/projects/v1/operations/delete-project/displayName.md diff --git a/services/projects/v1/operations/get-my-favorite-projects/description.md b/apis/projects/v1/operations/get-my-favorite-projects/description.md similarity index 100% rename from services/projects/v1/operations/get-my-favorite-projects/description.md rename to apis/projects/v1/operations/get-my-favorite-projects/description.md diff --git a/services/projects/v1/operations/get-my-favorite-projects/displayName.md b/apis/projects/v1/operations/get-my-favorite-projects/displayName.md similarity index 100% rename from services/projects/v1/operations/get-my-favorite-projects/displayName.md rename to apis/projects/v1/operations/get-my-favorite-projects/displayName.md diff --git a/services/projects/v1/operations/get-my-recently-used-projects/description.md b/apis/projects/v1/operations/get-my-recently-used-projects/description.md similarity index 100% rename from services/projects/v1/operations/get-my-recently-used-projects/description.md rename to apis/projects/v1/operations/get-my-recently-used-projects/description.md diff --git a/services/projects/v1/operations/get-my-recently-used-projects/displayName.md b/apis/projects/v1/operations/get-my-recently-used-projects/displayName.md similarity index 100% rename from services/projects/v1/operations/get-my-recently-used-projects/displayName.md rename to apis/projects/v1/operations/get-my-recently-used-projects/displayName.md diff --git a/services/projects/v1/operations/get-project-roles/description.md b/apis/projects/v1/operations/get-project-roles/description.md similarity index 100% rename from services/projects/v1/operations/get-project-roles/description.md rename to apis/projects/v1/operations/get-project-roles/description.md diff --git a/services/projects/v1/operations/get-project-roles/displayName.md b/apis/projects/v1/operations/get-project-roles/displayName.md similarity index 100% rename from services/projects/v1/operations/get-project-roles/displayName.md rename to apis/projects/v1/operations/get-project-roles/displayName.md diff --git a/services/projects/v1/operations/get-project-team-member-details/description.md b/apis/projects/v1/operations/get-project-team-member-details/description.md similarity index 100% rename from services/projects/v1/operations/get-project-team-member-details/description.md rename to apis/projects/v1/operations/get-project-team-member-details/description.md diff --git a/services/projects/v1/operations/get-project-team-member-details/displayName.md b/apis/projects/v1/operations/get-project-team-member-details/displayName.md similarity index 100% rename from services/projects/v1/operations/get-project-team-member-details/displayName.md rename to apis/projects/v1/operations/get-project-team-member-details/displayName.md diff --git a/services/projects/v1/operations/get-project-team-members/description.md b/apis/projects/v1/operations/get-project-team-members/description.md similarity index 100% rename from services/projects/v1/operations/get-project-team-members/description.md rename to apis/projects/v1/operations/get-project-team-members/description.md diff --git a/services/projects/v1/operations/get-project-team-members/displayName.md b/apis/projects/v1/operations/get-project-team-members/displayName.md similarity index 100% rename from services/projects/v1/operations/get-project-team-members/displayName.md rename to apis/projects/v1/operations/get-project-team-members/displayName.md diff --git a/services/projects/v1/operations/get-project/description.md b/apis/projects/v1/operations/get-project/description.md similarity index 100% rename from services/projects/v1/operations/get-project/description.md rename to apis/projects/v1/operations/get-project/description.md diff --git a/services/projects/v1/operations/get-project/displayName.md b/apis/projects/v1/operations/get-project/displayName.md similarity index 100% rename from services/projects/v1/operations/get-project/displayName.md rename to apis/projects/v1/operations/get-project/displayName.md diff --git a/services/projects/v1/operations/get-user-permissions/description.md b/apis/projects/v1/operations/get-user-permissions/description.md similarity index 100% rename from services/projects/v1/operations/get-user-permissions/description.md rename to apis/projects/v1/operations/get-user-permissions/description.md diff --git a/services/projects/v1/operations/get-user-permissions/displayName.md b/apis/projects/v1/operations/get-user-permissions/displayName.md similarity index 100% rename from services/projects/v1/operations/get-user-permissions/displayName.md rename to apis/projects/v1/operations/get-user-permissions/displayName.md diff --git a/services/projects/v1/operations/my-projects/description.md b/apis/projects/v1/operations/my-projects/description.md similarity index 100% rename from services/projects/v1/operations/my-projects/description.md rename to apis/projects/v1/operations/my-projects/description.md diff --git a/services/projects/v1/operations/my-projects/displayName.md b/apis/projects/v1/operations/my-projects/displayName.md similarity index 100% rename from services/projects/v1/operations/my-projects/displayName.md rename to apis/projects/v1/operations/my-projects/displayName.md diff --git a/services/projects/v1/operations/remove-project-from-my-favorites/description.md b/apis/projects/v1/operations/remove-project-from-my-favorites/description.md similarity index 100% rename from services/projects/v1/operations/remove-project-from-my-favorites/description.md rename to apis/projects/v1/operations/remove-project-from-my-favorites/description.md diff --git a/services/projects/v1/operations/remove-project-from-my-favorites/displayName.md b/apis/projects/v1/operations/remove-project-from-my-favorites/displayName.md similarity index 100% rename from services/projects/v1/operations/remove-project-from-my-favorites/displayName.md rename to apis/projects/v1/operations/remove-project-from-my-favorites/displayName.md diff --git a/services/projects/v1/operations/remove-project-team-member/description.md b/apis/projects/v1/operations/remove-project-team-member/description.md similarity index 100% rename from services/projects/v1/operations/remove-project-team-member/description.md rename to apis/projects/v1/operations/remove-project-team-member/description.md diff --git a/services/projects/v1/operations/remove-project-team-member/displayName.md b/apis/projects/v1/operations/remove-project-team-member/displayName.md similarity index 100% rename from services/projects/v1/operations/remove-project-team-member/displayName.md rename to apis/projects/v1/operations/remove-project-team-member/displayName.md diff --git a/services/projects/v1/operations/update-project-role/description.md b/apis/projects/v1/operations/update-project-role/description.md similarity index 100% rename from services/projects/v1/operations/update-project-role/description.md rename to apis/projects/v1/operations/update-project-role/description.md diff --git a/services/projects/v1/operations/update-project-role/displayName.md b/apis/projects/v1/operations/update-project-role/displayName.md similarity index 100% rename from services/projects/v1/operations/update-project-role/displayName.md rename to apis/projects/v1/operations/update-project-role/displayName.md diff --git a/services/projects/v1/operations/update-project-team-member-roles/description.md b/apis/projects/v1/operations/update-project-team-member-roles/description.md similarity index 100% rename from services/projects/v1/operations/update-project-team-member-roles/description.md rename to apis/projects/v1/operations/update-project-team-member-roles/description.md diff --git a/services/projects/v1/operations/update-project-team-member-roles/displayName.md b/apis/projects/v1/operations/update-project-team-member-roles/displayName.md similarity index 100% rename from services/projects/v1/operations/update-project-team-member-roles/displayName.md rename to apis/projects/v1/operations/update-project-team-member-roles/displayName.md diff --git a/services/projects/v1/operations/update-project/description.md b/apis/projects/v1/operations/update-project/description.md similarity index 100% rename from services/projects/v1/operations/update-project/description.md rename to apis/projects/v1/operations/update-project/description.md diff --git a/services/projects/v1/operations/update-project/displayName.md b/apis/projects/v1/operations/update-project/displayName.md similarity index 100% rename from services/projects/v1/operations/update-project/displayName.md rename to apis/projects/v1/operations/update-project/displayName.md diff --git a/services/projectwise365-insights/v1/description.md b/apis/projectwise365-insights/v1/description.md similarity index 100% rename from services/projectwise365-insights/v1/description.md rename to apis/projectwise365-insights/v1/description.md diff --git a/services/projectwise365-insights/v1/operations/project-metadata/description.md b/apis/projectwise365-insights/v1/operations/project-metadata/description.md similarity index 100% rename from services/projectwise365-insights/v1/operations/project-metadata/description.md rename to apis/projectwise365-insights/v1/operations/project-metadata/description.md diff --git a/services/projectwise365-insights/v1/operations/project-metadata/displayName.md b/apis/projectwise365-insights/v1/operations/project-metadata/displayName.md similarity index 100% rename from services/projectwise365-insights/v1/operations/project-metadata/displayName.md rename to apis/projectwise365-insights/v1/operations/project-metadata/displayName.md diff --git a/services/projectwise365-insights/v1/operations/project-odata/description.md b/apis/projectwise365-insights/v1/operations/project-odata/description.md similarity index 100% rename from services/projectwise365-insights/v1/operations/project-odata/description.md rename to apis/projectwise365-insights/v1/operations/project-odata/description.md diff --git a/services/projectwise365-insights/v1/operations/project-odata/displayName.md b/apis/projectwise365-insights/v1/operations/project-odata/displayName.md similarity index 100% rename from services/projectwise365-insights/v1/operations/project-odata/displayName.md rename to apis/projectwise365-insights/v1/operations/project-odata/displayName.md diff --git a/services/projectwise365-insights/v1/operations/project-schema/description.md b/apis/projectwise365-insights/v1/operations/project-schema/description.md similarity index 100% rename from services/projectwise365-insights/v1/operations/project-schema/description.md rename to apis/projectwise365-insights/v1/operations/project-schema/description.md diff --git a/services/projectwise365-insights/v1/operations/project-schema/displayName.md b/apis/projectwise365-insights/v1/operations/project-schema/displayName.md similarity index 100% rename from services/projectwise365-insights/v1/operations/project-schema/displayName.md rename to apis/projectwise365-insights/v1/operations/project-schema/displayName.md diff --git a/services/reality-data/v1/description.md b/apis/reality-data/v1/description.md similarity index 100% rename from services/reality-data/v1/description.md rename to apis/reality-data/v1/description.md diff --git a/services/reality-data/v1/operations/associate-to-project/description.md b/apis/reality-data/v1/operations/associate-to-project/description.md similarity index 100% rename from services/reality-data/v1/operations/associate-to-project/description.md rename to apis/reality-data/v1/operations/associate-to-project/description.md diff --git a/services/reality-data/v1/operations/associate-to-project/displayName.md b/apis/reality-data/v1/operations/associate-to-project/displayName.md similarity index 100% rename from services/reality-data/v1/operations/associate-to-project/displayName.md rename to apis/reality-data/v1/operations/associate-to-project/displayName.md diff --git a/services/reality-data/v1/operations/create-reality-data/description.md b/apis/reality-data/v1/operations/create-reality-data/description.md similarity index 100% rename from services/reality-data/v1/operations/create-reality-data/description.md rename to apis/reality-data/v1/operations/create-reality-data/description.md diff --git a/services/reality-data/v1/operations/create-reality-data/displayName.md b/apis/reality-data/v1/operations/create-reality-data/displayName.md similarity index 100% rename from services/reality-data/v1/operations/create-reality-data/displayName.md rename to apis/reality-data/v1/operations/create-reality-data/displayName.md diff --git a/services/reality-data/v1/operations/delete-reality-data/description.md b/apis/reality-data/v1/operations/delete-reality-data/description.md similarity index 100% rename from services/reality-data/v1/operations/delete-reality-data/description.md rename to apis/reality-data/v1/operations/delete-reality-data/description.md diff --git a/services/reality-data/v1/operations/delete-reality-data/displayName.md b/apis/reality-data/v1/operations/delete-reality-data/displayName.md similarity index 100% rename from services/reality-data/v1/operations/delete-reality-data/displayName.md rename to apis/reality-data/v1/operations/delete-reality-data/displayName.md diff --git a/services/reality-data/v1/operations/dissociate-from-project/description.md b/apis/reality-data/v1/operations/dissociate-from-project/description.md similarity index 100% rename from services/reality-data/v1/operations/dissociate-from-project/description.md rename to apis/reality-data/v1/operations/dissociate-from-project/description.md diff --git a/services/reality-data/v1/operations/dissociate-from-project/displayName.md b/apis/reality-data/v1/operations/dissociate-from-project/displayName.md similarity index 100% rename from services/reality-data/v1/operations/dissociate-from-project/displayName.md rename to apis/reality-data/v1/operations/dissociate-from-project/displayName.md diff --git a/services/reality-data/v1/operations/get-all-reality-data/description.md b/apis/reality-data/v1/operations/get-all-reality-data/description.md similarity index 100% rename from services/reality-data/v1/operations/get-all-reality-data/description.md rename to apis/reality-data/v1/operations/get-all-reality-data/description.md diff --git a/services/reality-data/v1/operations/get-all-reality-data/displayName.md b/apis/reality-data/v1/operations/get-all-reality-data/displayName.md similarity index 100% rename from services/reality-data/v1/operations/get-all-reality-data/displayName.md rename to apis/reality-data/v1/operations/get-all-reality-data/displayName.md diff --git a/services/reality-data/v1/operations/get-reality-data-container/description.md b/apis/reality-data/v1/operations/get-reality-data-container/description.md similarity index 100% rename from services/reality-data/v1/operations/get-reality-data-container/description.md rename to apis/reality-data/v1/operations/get-reality-data-container/description.md diff --git a/services/reality-data/v1/operations/get-reality-data-container/displayName.md b/apis/reality-data/v1/operations/get-reality-data-container/displayName.md similarity index 100% rename from services/reality-data/v1/operations/get-reality-data-container/displayName.md rename to apis/reality-data/v1/operations/get-reality-data-container/displayName.md diff --git a/services/reality-data/v1/operations/get-reality-data-details/description.md b/apis/reality-data/v1/operations/get-reality-data-details/description.md similarity index 100% rename from services/reality-data/v1/operations/get-reality-data-details/description.md rename to apis/reality-data/v1/operations/get-reality-data-details/description.md diff --git a/services/reality-data/v1/operations/get-reality-data-details/displayName.md b/apis/reality-data/v1/operations/get-reality-data-details/displayName.md similarity index 100% rename from services/reality-data/v1/operations/get-reality-data-details/displayName.md rename to apis/reality-data/v1/operations/get-reality-data-details/displayName.md diff --git a/services/reality-data/v1/operations/get-reality-data-projects/description.md b/apis/reality-data/v1/operations/get-reality-data-projects/description.md similarity index 100% rename from services/reality-data/v1/operations/get-reality-data-projects/description.md rename to apis/reality-data/v1/operations/get-reality-data-projects/description.md diff --git a/services/reality-data/v1/operations/get-reality-data-projects/displayName.md b/apis/reality-data/v1/operations/get-reality-data-projects/displayName.md similarity index 100% rename from services/reality-data/v1/operations/get-reality-data-projects/displayName.md rename to apis/reality-data/v1/operations/get-reality-data-projects/displayName.md diff --git a/services/reality-data/v1/operations/update-reality-data/description.md b/apis/reality-data/v1/operations/update-reality-data/description.md similarity index 100% rename from services/reality-data/v1/operations/update-reality-data/description.md rename to apis/reality-data/v1/operations/update-reality-data/description.md diff --git a/services/reality-data/v1/operations/update-reality-data/displayName.md b/apis/reality-data/v1/operations/update-reality-data/displayName.md similarity index 100% rename from services/reality-data/v1/operations/update-reality-data/displayName.md rename to apis/reality-data/v1/operations/update-reality-data/displayName.md diff --git a/services/reality-management/v1/description.md b/apis/reality-management/v1/description.md similarity index 100% rename from services/reality-management/v1/description.md rename to apis/reality-management/v1/description.md diff --git a/services/reality-management/v1/operations/associate-to-iTwin/description.md b/apis/reality-management/v1/operations/associate-to-iTwin/description.md similarity index 100% rename from services/reality-management/v1/operations/associate-to-iTwin/description.md rename to apis/reality-management/v1/operations/associate-to-iTwin/description.md diff --git a/services/reality-management/v1/operations/associate-to-iTwin/displayName.md b/apis/reality-management/v1/operations/associate-to-iTwin/displayName.md similarity index 100% rename from services/reality-management/v1/operations/associate-to-iTwin/displayName.md rename to apis/reality-management/v1/operations/associate-to-iTwin/displayName.md diff --git a/services/reality-management/v1/operations/create-reality-data/description.md b/apis/reality-management/v1/operations/create-reality-data/description.md similarity index 100% rename from services/reality-management/v1/operations/create-reality-data/description.md rename to apis/reality-management/v1/operations/create-reality-data/description.md diff --git a/services/reality-management/v1/operations/create-reality-data/displayName.md b/apis/reality-management/v1/operations/create-reality-data/displayName.md similarity index 100% rename from services/reality-management/v1/operations/create-reality-data/displayName.md rename to apis/reality-management/v1/operations/create-reality-data/displayName.md diff --git a/services/reality-management/v1/operations/delete-reality-data/description.md b/apis/reality-management/v1/operations/delete-reality-data/description.md similarity index 100% rename from services/reality-management/v1/operations/delete-reality-data/description.md rename to apis/reality-management/v1/operations/delete-reality-data/description.md diff --git a/services/reality-management/v1/operations/delete-reality-data/displayName.md b/apis/reality-management/v1/operations/delete-reality-data/displayName.md similarity index 100% rename from services/reality-management/v1/operations/delete-reality-data/displayName.md rename to apis/reality-management/v1/operations/delete-reality-data/displayName.md diff --git a/services/reality-management/v1/operations/dissociate-from-iTwin/description.md b/apis/reality-management/v1/operations/dissociate-from-iTwin/description.md similarity index 100% rename from services/reality-management/v1/operations/dissociate-from-iTwin/description.md rename to apis/reality-management/v1/operations/dissociate-from-iTwin/description.md diff --git a/services/reality-management/v1/operations/dissociate-from-iTwin/displayName.md b/apis/reality-management/v1/operations/dissociate-from-iTwin/displayName.md similarity index 100% rename from services/reality-management/v1/operations/dissociate-from-iTwin/displayName.md rename to apis/reality-management/v1/operations/dissociate-from-iTwin/displayName.md diff --git a/services/reality-management/v1/operations/get-all-reality-data/description.md b/apis/reality-management/v1/operations/get-all-reality-data/description.md similarity index 100% rename from services/reality-management/v1/operations/get-all-reality-data/description.md rename to apis/reality-management/v1/operations/get-all-reality-data/description.md diff --git a/services/reality-management/v1/operations/get-all-reality-data/displayName.md b/apis/reality-management/v1/operations/get-all-reality-data/displayName.md similarity index 100% rename from services/reality-management/v1/operations/get-all-reality-data/displayName.md rename to apis/reality-management/v1/operations/get-all-reality-data/displayName.md diff --git a/services/reality-management/v1/operations/get-read-access-to-reality-data-container/description.md b/apis/reality-management/v1/operations/get-read-access-to-reality-data-container/description.md similarity index 100% rename from services/reality-management/v1/operations/get-read-access-to-reality-data-container/description.md rename to apis/reality-management/v1/operations/get-read-access-to-reality-data-container/description.md diff --git a/services/reality-management/v1/operations/get-read-access-to-reality-data-container/displayName.md b/apis/reality-management/v1/operations/get-read-access-to-reality-data-container/displayName.md similarity index 100% rename from services/reality-management/v1/operations/get-read-access-to-reality-data-container/displayName.md rename to apis/reality-management/v1/operations/get-read-access-to-reality-data-container/displayName.md diff --git a/services/reality-management/v1/operations/get-reality-data-details/description.md b/apis/reality-management/v1/operations/get-reality-data-details/description.md similarity index 100% rename from services/reality-management/v1/operations/get-reality-data-details/description.md rename to apis/reality-management/v1/operations/get-reality-data-details/description.md diff --git a/services/reality-management/v1/operations/get-reality-data-details/displayName.md b/apis/reality-management/v1/operations/get-reality-data-details/displayName.md similarity index 100% rename from services/reality-management/v1/operations/get-reality-data-details/displayName.md rename to apis/reality-management/v1/operations/get-reality-data-details/displayName.md diff --git a/services/reality-management/v1/operations/get-reality-data-iTwins/description.md b/apis/reality-management/v1/operations/get-reality-data-iTwins/description.md similarity index 100% rename from services/reality-management/v1/operations/get-reality-data-iTwins/description.md rename to apis/reality-management/v1/operations/get-reality-data-iTwins/description.md diff --git a/services/reality-management/v1/operations/get-reality-data-iTwins/displayName.md b/apis/reality-management/v1/operations/get-reality-data-iTwins/displayName.md similarity index 100% rename from services/reality-management/v1/operations/get-reality-data-iTwins/displayName.md rename to apis/reality-management/v1/operations/get-reality-data-iTwins/displayName.md diff --git a/services/reality-management/v1/operations/get-write-access-to-reality-data-container/description.md b/apis/reality-management/v1/operations/get-write-access-to-reality-data-container/description.md similarity index 100% rename from services/reality-management/v1/operations/get-write-access-to-reality-data-container/description.md rename to apis/reality-management/v1/operations/get-write-access-to-reality-data-container/description.md diff --git a/services/reality-management/v1/operations/get-write-access-to-reality-data-container/displayName.md b/apis/reality-management/v1/operations/get-write-access-to-reality-data-container/displayName.md similarity index 100% rename from services/reality-management/v1/operations/get-write-access-to-reality-data-container/displayName.md rename to apis/reality-management/v1/operations/get-write-access-to-reality-data-container/displayName.md diff --git a/services/reality-management/v1/operations/update-reality-data/description.md b/apis/reality-management/v1/operations/update-reality-data/description.md similarity index 100% rename from services/reality-management/v1/operations/update-reality-data/description.md rename to apis/reality-management/v1/operations/update-reality-data/description.md diff --git a/services/reality-management/v1/operations/update-reality-data/displayName.md b/apis/reality-management/v1/operations/update-reality-data/displayName.md similarity index 100% rename from services/reality-management/v1/operations/update-reality-data/displayName.md rename to apis/reality-management/v1/operations/update-reality-data/displayName.md diff --git a/services/realityconversion/v1/description.md b/apis/realityconversion/v1/description.md similarity index 100% rename from services/realityconversion/v1/description.md rename to apis/realityconversion/v1/description.md diff --git a/services/realityconversion/v1/operations/jobs-create/description.md b/apis/realityconversion/v1/operations/jobs-create/description.md similarity index 100% rename from services/realityconversion/v1/operations/jobs-create/description.md rename to apis/realityconversion/v1/operations/jobs-create/description.md diff --git a/services/realityconversion/v1/operations/jobs-create/displayName.md b/apis/realityconversion/v1/operations/jobs-create/displayName.md similarity index 100% rename from services/realityconversion/v1/operations/jobs-create/displayName.md rename to apis/realityconversion/v1/operations/jobs-create/displayName.md diff --git a/services/realityconversion/v1/operations/jobs-delete/description.md b/apis/realityconversion/v1/operations/jobs-delete/description.md similarity index 100% rename from services/realityconversion/v1/operations/jobs-delete/description.md rename to apis/realityconversion/v1/operations/jobs-delete/description.md diff --git a/services/realityconversion/v1/operations/jobs-delete/displayName.md b/apis/realityconversion/v1/operations/jobs-delete/displayName.md similarity index 100% rename from services/realityconversion/v1/operations/jobs-delete/displayName.md rename to apis/realityconversion/v1/operations/jobs-delete/displayName.md diff --git a/services/realityconversion/v1/operations/jobs-get/description.md b/apis/realityconversion/v1/operations/jobs-get/description.md similarity index 100% rename from services/realityconversion/v1/operations/jobs-get/description.md rename to apis/realityconversion/v1/operations/jobs-get/description.md diff --git a/services/realityconversion/v1/operations/jobs-get/displayName.md b/apis/realityconversion/v1/operations/jobs-get/displayName.md similarity index 100% rename from services/realityconversion/v1/operations/jobs-get/displayName.md rename to apis/realityconversion/v1/operations/jobs-get/displayName.md diff --git a/services/realityconversion/v1/operations/jobs-patch/description.md b/apis/realityconversion/v1/operations/jobs-patch/description.md similarity index 100% rename from services/realityconversion/v1/operations/jobs-patch/description.md rename to apis/realityconversion/v1/operations/jobs-patch/description.md diff --git a/services/realityconversion/v1/operations/jobs-patch/displayName.md b/apis/realityconversion/v1/operations/jobs-patch/displayName.md similarity index 100% rename from services/realityconversion/v1/operations/jobs-patch/displayName.md rename to apis/realityconversion/v1/operations/jobs-patch/displayName.md diff --git a/services/realityconversion/v1/operations/jobs-progress/description.md b/apis/realityconversion/v1/operations/jobs-progress/description.md similarity index 100% rename from services/realityconversion/v1/operations/jobs-progress/description.md rename to apis/realityconversion/v1/operations/jobs-progress/description.md diff --git a/services/realityconversion/v1/operations/jobs-progress/displayName.md b/apis/realityconversion/v1/operations/jobs-progress/displayName.md similarity index 100% rename from services/realityconversion/v1/operations/jobs-progress/displayName.md rename to apis/realityconversion/v1/operations/jobs-progress/displayName.md diff --git a/services/realitydataanalysis/v1/description.md b/apis/realitydataanalysis/v1/description.md similarity index 100% rename from services/realitydataanalysis/v1/description.md rename to apis/realitydataanalysis/v1/description.md diff --git a/services/realitydataanalysis/v1/operations/jobs-create/description.md b/apis/realitydataanalysis/v1/operations/jobs-create/description.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-create/description.md rename to apis/realitydataanalysis/v1/operations/jobs-create/description.md diff --git a/services/realitydataanalysis/v1/operations/jobs-create/displayName.md b/apis/realitydataanalysis/v1/operations/jobs-create/displayName.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-create/displayName.md rename to apis/realitydataanalysis/v1/operations/jobs-create/displayName.md diff --git a/services/realitydataanalysis/v1/operations/jobs-delete/description.md b/apis/realitydataanalysis/v1/operations/jobs-delete/description.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-delete/description.md rename to apis/realitydataanalysis/v1/operations/jobs-delete/description.md diff --git a/services/realitydataanalysis/v1/operations/jobs-delete/displayName.md b/apis/realitydataanalysis/v1/operations/jobs-delete/displayName.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-delete/displayName.md rename to apis/realitydataanalysis/v1/operations/jobs-delete/displayName.md diff --git a/services/realitydataanalysis/v1/operations/jobs-get-all/description.md b/apis/realitydataanalysis/v1/operations/jobs-get-all/description.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-get-all/description.md rename to apis/realitydataanalysis/v1/operations/jobs-get-all/description.md diff --git a/services/realitydataanalysis/v1/operations/jobs-get-all/displayName.md b/apis/realitydataanalysis/v1/operations/jobs-get-all/displayName.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-get-all/displayName.md rename to apis/realitydataanalysis/v1/operations/jobs-get-all/displayName.md diff --git a/services/realitydataanalysis/v1/operations/jobs-get/description.md b/apis/realitydataanalysis/v1/operations/jobs-get/description.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-get/description.md rename to apis/realitydataanalysis/v1/operations/jobs-get/description.md diff --git a/services/realitydataanalysis/v1/operations/jobs-get/displayName.md b/apis/realitydataanalysis/v1/operations/jobs-get/displayName.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-get/displayName.md rename to apis/realitydataanalysis/v1/operations/jobs-get/displayName.md diff --git a/services/realitydataanalysis/v1/operations/jobs-patch/description.md b/apis/realitydataanalysis/v1/operations/jobs-patch/description.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-patch/description.md rename to apis/realitydataanalysis/v1/operations/jobs-patch/description.md diff --git a/services/realitydataanalysis/v1/operations/jobs-patch/displayName.md b/apis/realitydataanalysis/v1/operations/jobs-patch/displayName.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-patch/displayName.md rename to apis/realitydataanalysis/v1/operations/jobs-patch/displayName.md diff --git a/services/realitydataanalysis/v1/operations/jobs-progress/description.md b/apis/realitydataanalysis/v1/operations/jobs-progress/description.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-progress/description.md rename to apis/realitydataanalysis/v1/operations/jobs-progress/description.md diff --git a/services/realitydataanalysis/v1/operations/jobs-progress/displayName.md b/apis/realitydataanalysis/v1/operations/jobs-progress/displayName.md similarity index 100% rename from services/realitydataanalysis/v1/operations/jobs-progress/displayName.md rename to apis/realitydataanalysis/v1/operations/jobs-progress/displayName.md diff --git a/services/reporting/v2/description.md b/apis/reporting/v2/description.md similarity index 100% rename from services/reporting/v2/description.md rename to apis/reporting/v2/description.md diff --git a/services/reporting/v2/operations/create-apikey/description.md b/apis/reporting/v2/operations/create-apikey/description.md similarity index 100% rename from services/reporting/v2/operations/create-apikey/description.md rename to apis/reporting/v2/operations/create-apikey/description.md diff --git a/services/reporting/v2/operations/create-apikey/displayName.md b/apis/reporting/v2/operations/create-apikey/displayName.md similarity index 100% rename from services/reporting/v2/operations/create-apikey/displayName.md rename to apis/reporting/v2/operations/create-apikey/displayName.md diff --git a/services/reporting/v2/operations/create-report-mapping/description.md b/apis/reporting/v2/operations/create-report-mapping/description.md similarity index 100% rename from services/reporting/v2/operations/create-report-mapping/description.md rename to apis/reporting/v2/operations/create-report-mapping/description.md diff --git a/services/reporting/v2/operations/create-report-mapping/displayName.md b/apis/reporting/v2/operations/create-report-mapping/displayName.md similarity index 100% rename from services/reporting/v2/operations/create-report-mapping/displayName.md rename to apis/reporting/v2/operations/create-report-mapping/displayName.md diff --git a/services/reporting/v2/operations/create-report/description.md b/apis/reporting/v2/operations/create-report/description.md similarity index 100% rename from services/reporting/v2/operations/create-report/description.md rename to apis/reporting/v2/operations/create-report/description.md diff --git a/services/reporting/v2/operations/create-report/displayName.md b/apis/reporting/v2/operations/create-report/displayName.md similarity index 100% rename from services/reporting/v2/operations/create-report/displayName.md rename to apis/reporting/v2/operations/create-report/displayName.md diff --git a/services/reporting/v2/operations/delete-report-mapping/description.md b/apis/reporting/v2/operations/delete-report-mapping/description.md similarity index 100% rename from services/reporting/v2/operations/delete-report-mapping/description.md rename to apis/reporting/v2/operations/delete-report-mapping/description.md diff --git a/services/reporting/v2/operations/delete-report-mapping/displayName.md b/apis/reporting/v2/operations/delete-report-mapping/displayName.md similarity index 100% rename from services/reporting/v2/operations/delete-report-mapping/displayName.md rename to apis/reporting/v2/operations/delete-report-mapping/displayName.md diff --git a/services/reporting/v2/operations/delete-report/description.md b/apis/reporting/v2/operations/delete-report/description.md similarity index 100% rename from services/reporting/v2/operations/delete-report/description.md rename to apis/reporting/v2/operations/delete-report/description.md diff --git a/services/reporting/v2/operations/delete-report/displayName.md b/apis/reporting/v2/operations/delete-report/displayName.md similarity index 100% rename from services/reporting/v2/operations/delete-report/displayName.md rename to apis/reporting/v2/operations/delete-report/displayName.md diff --git a/services/reporting/v2/operations/get-apikey/description.md b/apis/reporting/v2/operations/get-apikey/description.md similarity index 100% rename from services/reporting/v2/operations/get-apikey/description.md rename to apis/reporting/v2/operations/get-apikey/description.md diff --git a/services/reporting/v2/operations/get-apikey/displayName.md b/apis/reporting/v2/operations/get-apikey/displayName.md similarity index 100% rename from services/reporting/v2/operations/get-apikey/displayName.md rename to apis/reporting/v2/operations/get-apikey/displayName.md diff --git a/services/reporting/v2/operations/get-apikeys/description.md b/apis/reporting/v2/operations/get-apikeys/description.md similarity index 100% rename from services/reporting/v2/operations/get-apikeys/description.md rename to apis/reporting/v2/operations/get-apikeys/description.md diff --git a/services/reporting/v2/operations/get-apikeys/displayName.md b/apis/reporting/v2/operations/get-apikeys/displayName.md similarity index 100% rename from services/reporting/v2/operations/get-apikeys/displayName.md rename to apis/reporting/v2/operations/get-apikeys/displayName.md diff --git a/services/reporting/v2/operations/get-itwin-reports/description.md b/apis/reporting/v2/operations/get-itwin-reports/description.md similarity index 100% rename from services/reporting/v2/operations/get-itwin-reports/description.md rename to apis/reporting/v2/operations/get-itwin-reports/description.md diff --git a/services/reporting/v2/operations/get-itwin-reports/displayName.md b/apis/reporting/v2/operations/get-itwin-reports/displayName.md similarity index 100% rename from services/reporting/v2/operations/get-itwin-reports/displayName.md rename to apis/reporting/v2/operations/get-itwin-reports/displayName.md diff --git a/services/reporting/v2/operations/get-report-mappings/description.md b/apis/reporting/v2/operations/get-report-mappings/description.md similarity index 100% rename from services/reporting/v2/operations/get-report-mappings/description.md rename to apis/reporting/v2/operations/get-report-mappings/description.md diff --git a/services/reporting/v2/operations/get-report-mappings/displayName.md b/apis/reporting/v2/operations/get-report-mappings/displayName.md similarity index 100% rename from services/reporting/v2/operations/get-report-mappings/displayName.md rename to apis/reporting/v2/operations/get-report-mappings/displayName.md diff --git a/services/reporting/v2/operations/get-report/description.md b/apis/reporting/v2/operations/get-report/description.md similarity index 100% rename from services/reporting/v2/operations/get-report/description.md rename to apis/reporting/v2/operations/get-report/description.md diff --git a/services/reporting/v2/operations/get-report/displayName.md b/apis/reporting/v2/operations/get-report/displayName.md similarity index 100% rename from services/reporting/v2/operations/get-report/displayName.md rename to apis/reporting/v2/operations/get-report/displayName.md diff --git a/services/reporting/v2/operations/odata-entity/description.md b/apis/reporting/v2/operations/odata-entity/description.md similarity index 100% rename from services/reporting/v2/operations/odata-entity/description.md rename to apis/reporting/v2/operations/odata-entity/description.md diff --git a/services/reporting/v2/operations/odata-entity/displayName.md b/apis/reporting/v2/operations/odata-entity/displayName.md similarity index 100% rename from services/reporting/v2/operations/odata-entity/displayName.md rename to apis/reporting/v2/operations/odata-entity/displayName.md diff --git a/services/reporting/v2/operations/odata-metadata/description.md b/apis/reporting/v2/operations/odata-metadata/description.md similarity index 100% rename from services/reporting/v2/operations/odata-metadata/description.md rename to apis/reporting/v2/operations/odata-metadata/description.md diff --git a/services/reporting/v2/operations/odata-metadata/displayName.md b/apis/reporting/v2/operations/odata-metadata/displayName.md similarity index 100% rename from services/reporting/v2/operations/odata-metadata/displayName.md rename to apis/reporting/v2/operations/odata-metadata/displayName.md diff --git a/services/reporting/v2/operations/odata/description.md b/apis/reporting/v2/operations/odata/description.md similarity index 100% rename from services/reporting/v2/operations/odata/description.md rename to apis/reporting/v2/operations/odata/description.md diff --git a/services/reporting/v2/operations/odata/displayName.md b/apis/reporting/v2/operations/odata/displayName.md similarity index 100% rename from services/reporting/v2/operations/odata/displayName.md rename to apis/reporting/v2/operations/odata/displayName.md diff --git a/services/reporting/v2/operations/revoke-apikey/description.md b/apis/reporting/v2/operations/revoke-apikey/description.md similarity index 100% rename from services/reporting/v2/operations/revoke-apikey/description.md rename to apis/reporting/v2/operations/revoke-apikey/description.md diff --git a/services/reporting/v2/operations/revoke-apikey/displayName.md b/apis/reporting/v2/operations/revoke-apikey/displayName.md similarity index 100% rename from services/reporting/v2/operations/revoke-apikey/displayName.md rename to apis/reporting/v2/operations/revoke-apikey/displayName.md diff --git a/services/reporting/v2/operations/update-apikey/description.md b/apis/reporting/v2/operations/update-apikey/description.md similarity index 100% rename from services/reporting/v2/operations/update-apikey/description.md rename to apis/reporting/v2/operations/update-apikey/description.md diff --git a/services/reporting/v2/operations/update-apikey/displayName.md b/apis/reporting/v2/operations/update-apikey/displayName.md similarity index 100% rename from services/reporting/v2/operations/update-apikey/displayName.md rename to apis/reporting/v2/operations/update-apikey/displayName.md diff --git a/services/reporting/v2/operations/update-report/description.md b/apis/reporting/v2/operations/update-report/description.md similarity index 100% rename from services/reporting/v2/operations/update-report/description.md rename to apis/reporting/v2/operations/update-report/description.md diff --git a/services/reporting/v2/operations/update-report/displayName.md b/apis/reporting/v2/operations/update-report/displayName.md similarity index 100% rename from services/reporting/v2/operations/update-report/displayName.md rename to apis/reporting/v2/operations/update-report/displayName.md diff --git a/services/savedviews/v1/description.md b/apis/savedviews/v1/description.md similarity index 100% rename from services/savedviews/v1/description.md rename to apis/savedviews/v1/description.md diff --git a/services/savedviews/v1/operations/add-image/description.md b/apis/savedviews/v1/operations/add-image/description.md similarity index 100% rename from services/savedviews/v1/operations/add-image/description.md rename to apis/savedviews/v1/operations/add-image/description.md diff --git a/services/savedviews/v1/operations/add-image/displayName.md b/apis/savedviews/v1/operations/add-image/displayName.md similarity index 100% rename from services/savedviews/v1/operations/add-image/displayName.md rename to apis/savedviews/v1/operations/add-image/displayName.md diff --git a/services/savedviews/v1/operations/create-extension/description.md b/apis/savedviews/v1/operations/create-extension/description.md similarity index 100% rename from services/savedviews/v1/operations/create-extension/description.md rename to apis/savedviews/v1/operations/create-extension/description.md diff --git a/services/savedviews/v1/operations/create-extension/displayName.md b/apis/savedviews/v1/operations/create-extension/displayName.md similarity index 100% rename from services/savedviews/v1/operations/create-extension/displayName.md rename to apis/savedviews/v1/operations/create-extension/displayName.md diff --git a/services/savedviews/v1/operations/create-group/description.md b/apis/savedviews/v1/operations/create-group/description.md similarity index 100% rename from services/savedviews/v1/operations/create-group/description.md rename to apis/savedviews/v1/operations/create-group/description.md diff --git a/services/savedviews/v1/operations/create-group/displayName.md b/apis/savedviews/v1/operations/create-group/displayName.md similarity index 100% rename from services/savedviews/v1/operations/create-group/displayName.md rename to apis/savedviews/v1/operations/create-group/displayName.md diff --git a/services/savedviews/v1/operations/create-savedview/description.md b/apis/savedviews/v1/operations/create-savedview/description.md similarity index 100% rename from services/savedviews/v1/operations/create-savedview/description.md rename to apis/savedviews/v1/operations/create-savedview/description.md diff --git a/services/savedviews/v1/operations/create-savedview/displayName.md b/apis/savedviews/v1/operations/create-savedview/displayName.md similarity index 100% rename from services/savedviews/v1/operations/create-savedview/displayName.md rename to apis/savedviews/v1/operations/create-savedview/displayName.md diff --git a/services/savedviews/v1/operations/create-tag/description.md b/apis/savedviews/v1/operations/create-tag/description.md similarity index 100% rename from services/savedviews/v1/operations/create-tag/description.md rename to apis/savedviews/v1/operations/create-tag/description.md diff --git a/services/savedviews/v1/operations/create-tag/displayName.md b/apis/savedviews/v1/operations/create-tag/displayName.md similarity index 100% rename from services/savedviews/v1/operations/create-tag/displayName.md rename to apis/savedviews/v1/operations/create-tag/displayName.md diff --git a/services/savedviews/v1/operations/delete-extension/description.md b/apis/savedviews/v1/operations/delete-extension/description.md similarity index 100% rename from services/savedviews/v1/operations/delete-extension/description.md rename to apis/savedviews/v1/operations/delete-extension/description.md diff --git a/services/savedviews/v1/operations/delete-extension/displayName.md b/apis/savedviews/v1/operations/delete-extension/displayName.md similarity index 100% rename from services/savedviews/v1/operations/delete-extension/displayName.md rename to apis/savedviews/v1/operations/delete-extension/displayName.md diff --git a/services/savedviews/v1/operations/delete-group/description.md b/apis/savedviews/v1/operations/delete-group/description.md similarity index 100% rename from services/savedviews/v1/operations/delete-group/description.md rename to apis/savedviews/v1/operations/delete-group/description.md diff --git a/services/savedviews/v1/operations/delete-group/displayName.md b/apis/savedviews/v1/operations/delete-group/displayName.md similarity index 100% rename from services/savedviews/v1/operations/delete-group/displayName.md rename to apis/savedviews/v1/operations/delete-group/displayName.md diff --git a/services/savedviews/v1/operations/delete-savedview/description.md b/apis/savedviews/v1/operations/delete-savedview/description.md similarity index 100% rename from services/savedviews/v1/operations/delete-savedview/description.md rename to apis/savedviews/v1/operations/delete-savedview/description.md diff --git a/services/savedviews/v1/operations/delete-savedview/displayName.md b/apis/savedviews/v1/operations/delete-savedview/displayName.md similarity index 100% rename from services/savedviews/v1/operations/delete-savedview/displayName.md rename to apis/savedviews/v1/operations/delete-savedview/displayName.md diff --git a/services/savedviews/v1/operations/delete-tag/description.md b/apis/savedviews/v1/operations/delete-tag/description.md similarity index 100% rename from services/savedviews/v1/operations/delete-tag/description.md rename to apis/savedviews/v1/operations/delete-tag/description.md diff --git a/services/savedviews/v1/operations/delete-tag/displayName.md b/apis/savedviews/v1/operations/delete-tag/displayName.md similarity index 100% rename from services/savedviews/v1/operations/delete-tag/displayName.md rename to apis/savedviews/v1/operations/delete-tag/displayName.md diff --git a/services/savedviews/v1/operations/get-all-extensions/description.md b/apis/savedviews/v1/operations/get-all-extensions/description.md similarity index 100% rename from services/savedviews/v1/operations/get-all-extensions/description.md rename to apis/savedviews/v1/operations/get-all-extensions/description.md diff --git a/services/savedviews/v1/operations/get-all-extensions/displayName.md b/apis/savedviews/v1/operations/get-all-extensions/displayName.md similarity index 100% rename from services/savedviews/v1/operations/get-all-extensions/displayName.md rename to apis/savedviews/v1/operations/get-all-extensions/displayName.md diff --git a/services/savedviews/v1/operations/get-all-groups/description.md b/apis/savedviews/v1/operations/get-all-groups/description.md similarity index 100% rename from services/savedviews/v1/operations/get-all-groups/description.md rename to apis/savedviews/v1/operations/get-all-groups/description.md diff --git a/services/savedviews/v1/operations/get-all-groups/displayName.md b/apis/savedviews/v1/operations/get-all-groups/displayName.md similarity index 100% rename from services/savedviews/v1/operations/get-all-groups/displayName.md rename to apis/savedviews/v1/operations/get-all-groups/displayName.md diff --git a/services/savedviews/v1/operations/get-all-savedviews/description.md b/apis/savedviews/v1/operations/get-all-savedviews/description.md similarity index 100% rename from services/savedviews/v1/operations/get-all-savedviews/description.md rename to apis/savedviews/v1/operations/get-all-savedviews/description.md diff --git a/services/savedviews/v1/operations/get-all-savedviews/displayName.md b/apis/savedviews/v1/operations/get-all-savedviews/displayName.md similarity index 100% rename from services/savedviews/v1/operations/get-all-savedviews/displayName.md rename to apis/savedviews/v1/operations/get-all-savedviews/displayName.md diff --git a/services/savedviews/v1/operations/get-all-tags/description.md b/apis/savedviews/v1/operations/get-all-tags/description.md similarity index 100% rename from services/savedviews/v1/operations/get-all-tags/description.md rename to apis/savedviews/v1/operations/get-all-tags/description.md diff --git a/services/savedviews/v1/operations/get-all-tags/displayName.md b/apis/savedviews/v1/operations/get-all-tags/displayName.md similarity index 100% rename from services/savedviews/v1/operations/get-all-tags/displayName.md rename to apis/savedviews/v1/operations/get-all-tags/displayName.md diff --git a/services/savedviews/v1/operations/get-extension/description.md b/apis/savedviews/v1/operations/get-extension/description.md similarity index 100% rename from services/savedviews/v1/operations/get-extension/description.md rename to apis/savedviews/v1/operations/get-extension/description.md diff --git a/services/savedviews/v1/operations/get-extension/displayName.md b/apis/savedviews/v1/operations/get-extension/displayName.md similarity index 100% rename from services/savedviews/v1/operations/get-extension/displayName.md rename to apis/savedviews/v1/operations/get-extension/displayName.md diff --git a/services/savedviews/v1/operations/get-group/description.md b/apis/savedviews/v1/operations/get-group/description.md similarity index 100% rename from services/savedviews/v1/operations/get-group/description.md rename to apis/savedviews/v1/operations/get-group/description.md diff --git a/services/savedviews/v1/operations/get-group/displayName.md b/apis/savedviews/v1/operations/get-group/displayName.md similarity index 100% rename from services/savedviews/v1/operations/get-group/displayName.md rename to apis/savedviews/v1/operations/get-group/displayName.md diff --git a/services/savedviews/v1/operations/get-image/description.md b/apis/savedviews/v1/operations/get-image/description.md similarity index 100% rename from services/savedviews/v1/operations/get-image/description.md rename to apis/savedviews/v1/operations/get-image/description.md diff --git a/services/savedviews/v1/operations/get-image/displayName.md b/apis/savedviews/v1/operations/get-image/displayName.md similarity index 100% rename from services/savedviews/v1/operations/get-image/displayName.md rename to apis/savedviews/v1/operations/get-image/displayName.md diff --git a/services/savedviews/v1/operations/get-savedview/description.md b/apis/savedviews/v1/operations/get-savedview/description.md similarity index 100% rename from services/savedviews/v1/operations/get-savedview/description.md rename to apis/savedviews/v1/operations/get-savedview/description.md diff --git a/services/savedviews/v1/operations/get-savedview/displayName.md b/apis/savedviews/v1/operations/get-savedview/displayName.md similarity index 100% rename from services/savedviews/v1/operations/get-savedview/displayName.md rename to apis/savedviews/v1/operations/get-savedview/displayName.md diff --git a/services/savedviews/v1/operations/get-tag/description.md b/apis/savedviews/v1/operations/get-tag/description.md similarity index 100% rename from services/savedviews/v1/operations/get-tag/description.md rename to apis/savedviews/v1/operations/get-tag/description.md diff --git a/services/savedviews/v1/operations/get-tag/displayName.md b/apis/savedviews/v1/operations/get-tag/displayName.md similarity index 100% rename from services/savedviews/v1/operations/get-tag/displayName.md rename to apis/savedviews/v1/operations/get-tag/displayName.md diff --git a/services/savedviews/v1/operations/update-group/description.md b/apis/savedviews/v1/operations/update-group/description.md similarity index 100% rename from services/savedviews/v1/operations/update-group/description.md rename to apis/savedviews/v1/operations/update-group/description.md diff --git a/services/savedviews/v1/operations/update-group/displayName.md b/apis/savedviews/v1/operations/update-group/displayName.md similarity index 100% rename from services/savedviews/v1/operations/update-group/displayName.md rename to apis/savedviews/v1/operations/update-group/displayName.md diff --git a/services/savedviews/v1/operations/update-savedview/description.md b/apis/savedviews/v1/operations/update-savedview/description.md similarity index 100% rename from services/savedviews/v1/operations/update-savedview/description.md rename to apis/savedviews/v1/operations/update-savedview/description.md diff --git a/services/savedviews/v1/operations/update-savedview/displayName.md b/apis/savedviews/v1/operations/update-savedview/displayName.md similarity index 100% rename from services/savedviews/v1/operations/update-savedview/displayName.md rename to apis/savedviews/v1/operations/update-savedview/displayName.md diff --git a/services/savedviews/v1/operations/update-tag/description.md b/apis/savedviews/v1/operations/update-tag/description.md similarity index 100% rename from services/savedviews/v1/operations/update-tag/description.md rename to apis/savedviews/v1/operations/update-tag/description.md diff --git a/services/savedviews/v1/operations/update-tag/displayName.md b/apis/savedviews/v1/operations/update-tag/displayName.md similarity index 100% rename from services/savedviews/v1/operations/update-tag/displayName.md rename to apis/savedviews/v1/operations/update-tag/displayName.md diff --git a/services/sensor-data/v1/description.md b/apis/sensor-data/v1/description.md similarity index 100% rename from services/sensor-data/v1/description.md rename to apis/sensor-data/v1/description.md diff --git a/services/sensor-data/v1/operations/get-nodes/description.md b/apis/sensor-data/v1/operations/get-nodes/description.md similarity index 100% rename from services/sensor-data/v1/operations/get-nodes/description.md rename to apis/sensor-data/v1/operations/get-nodes/description.md diff --git a/services/sensor-data/v1/operations/get-nodes/displayName.md b/apis/sensor-data/v1/operations/get-nodes/displayName.md similarity index 100% rename from services/sensor-data/v1/operations/get-nodes/displayName.md rename to apis/sensor-data/v1/operations/get-nodes/displayName.md diff --git a/services/sensor-data/v1/operations/process-integration/description.md b/apis/sensor-data/v1/operations/process-integration/description.md similarity index 100% rename from services/sensor-data/v1/operations/process-integration/description.md rename to apis/sensor-data/v1/operations/process-integration/description.md diff --git a/services/sensor-data/v1/operations/process-integration/displayName.md b/apis/sensor-data/v1/operations/process-integration/displayName.md similarity index 100% rename from services/sensor-data/v1/operations/process-integration/displayName.md rename to apis/sensor-data/v1/operations/process-integration/displayName.md diff --git a/services/sensor-data/v1/operations/query-raw-data/description.md b/apis/sensor-data/v1/operations/query-raw-data/description.md similarity index 100% rename from services/sensor-data/v1/operations/query-raw-data/description.md rename to apis/sensor-data/v1/operations/query-raw-data/description.md diff --git a/services/sensor-data/v1/operations/query-raw-data/displayName.md b/apis/sensor-data/v1/operations/query-raw-data/displayName.md similarity index 100% rename from services/sensor-data/v1/operations/query-raw-data/displayName.md rename to apis/sensor-data/v1/operations/query-raw-data/displayName.md diff --git a/services/sensor-data/v1/operations/remove-data/description.md b/apis/sensor-data/v1/operations/remove-data/description.md similarity index 100% rename from services/sensor-data/v1/operations/remove-data/description.md rename to apis/sensor-data/v1/operations/remove-data/description.md diff --git a/services/sensor-data/v1/operations/remove-data/displayName.md b/apis/sensor-data/v1/operations/remove-data/displayName.md similarity index 100% rename from services/sensor-data/v1/operations/remove-data/displayName.md rename to apis/sensor-data/v1/operations/remove-data/displayName.md diff --git a/services/sensor-data/v1/operations/upload-data/description.md b/apis/sensor-data/v1/operations/upload-data/description.md similarity index 100% rename from services/sensor-data/v1/operations/upload-data/description.md rename to apis/sensor-data/v1/operations/upload-data/description.md diff --git a/services/sensor-data/v1/operations/upload-data/displayName.md b/apis/sensor-data/v1/operations/upload-data/displayName.md similarity index 100% rename from services/sensor-data/v1/operations/upload-data/displayName.md rename to apis/sensor-data/v1/operations/upload-data/displayName.md diff --git a/services/storage-container/v1/description.md b/apis/storage-container/v1/description.md similarity index 100% rename from services/storage-container/v1/description.md rename to apis/storage-container/v1/description.md diff --git a/services/storage-container/v1/operations/clone-storage-container/description.md b/apis/storage-container/v1/operations/clone-storage-container/description.md similarity index 100% rename from services/storage-container/v1/operations/clone-storage-container/description.md rename to apis/storage-container/v1/operations/clone-storage-container/description.md diff --git a/services/storage-container/v1/operations/clone-storage-container/displayName.md b/apis/storage-container/v1/operations/clone-storage-container/displayName.md similarity index 100% rename from services/storage-container/v1/operations/clone-storage-container/displayName.md rename to apis/storage-container/v1/operations/clone-storage-container/displayName.md diff --git a/services/storage-container/v1/operations/create-storage-container/description.md b/apis/storage-container/v1/operations/create-storage-container/description.md similarity index 100% rename from services/storage-container/v1/operations/create-storage-container/description.md rename to apis/storage-container/v1/operations/create-storage-container/description.md diff --git a/services/storage-container/v1/operations/create-storage-container/displayName.md b/apis/storage-container/v1/operations/create-storage-container/displayName.md similarity index 100% rename from services/storage-container/v1/operations/create-storage-container/displayName.md rename to apis/storage-container/v1/operations/create-storage-container/displayName.md diff --git a/services/storage-container/v1/operations/delete-storage-container/description.md b/apis/storage-container/v1/operations/delete-storage-container/description.md similarity index 100% rename from services/storage-container/v1/operations/delete-storage-container/description.md rename to apis/storage-container/v1/operations/delete-storage-container/description.md diff --git a/services/storage-container/v1/operations/delete-storage-container/displayName.md b/apis/storage-container/v1/operations/delete-storage-container/displayName.md similarity index 100% rename from services/storage-container/v1/operations/delete-storage-container/displayName.md rename to apis/storage-container/v1/operations/delete-storage-container/displayName.md diff --git a/services/storage-container/v1/operations/get-single-storage-container/description.md b/apis/storage-container/v1/operations/get-single-storage-container/description.md similarity index 100% rename from services/storage-container/v1/operations/get-single-storage-container/description.md rename to apis/storage-container/v1/operations/get-single-storage-container/description.md diff --git a/services/storage-container/v1/operations/get-single-storage-container/displayName.md b/apis/storage-container/v1/operations/get-single-storage-container/displayName.md similarity index 100% rename from services/storage-container/v1/operations/get-single-storage-container/displayName.md rename to apis/storage-container/v1/operations/get-single-storage-container/displayName.md diff --git a/services/storage-container/v1/operations/get-storage-containers/description.md b/apis/storage-container/v1/operations/get-storage-containers/description.md similarity index 100% rename from services/storage-container/v1/operations/get-storage-containers/description.md rename to apis/storage-container/v1/operations/get-storage-containers/description.md diff --git a/services/storage-container/v1/operations/get-storage-containers/displayName.md b/apis/storage-container/v1/operations/get-storage-containers/displayName.md similarity index 100% rename from services/storage-container/v1/operations/get-storage-containers/displayName.md rename to apis/storage-container/v1/operations/get-storage-containers/displayName.md diff --git a/services/storage-container/v1/operations/update-container-metadata-json/description.md b/apis/storage-container/v1/operations/update-container-metadata-json/description.md similarity index 100% rename from services/storage-container/v1/operations/update-container-metadata-json/description.md rename to apis/storage-container/v1/operations/update-container-metadata-json/description.md diff --git a/services/storage-container/v1/operations/update-container-metadata-json/displayName.md b/apis/storage-container/v1/operations/update-container-metadata-json/displayName.md similarity index 100% rename from services/storage-container/v1/operations/update-container-metadata-json/displayName.md rename to apis/storage-container/v1/operations/update-container-metadata-json/displayName.md diff --git a/services/storage/v1/description.md b/apis/storage/v1/description.md similarity index 100% rename from services/storage/v1/description.md rename to apis/storage/v1/description.md diff --git a/services/storage/v1/operations/complete-file-creation/description.md b/apis/storage/v1/operations/complete-file-creation/description.md similarity index 100% rename from services/storage/v1/operations/complete-file-creation/description.md rename to apis/storage/v1/operations/complete-file-creation/description.md diff --git a/services/storage/v1/operations/complete-file-creation/displayName.md b/apis/storage/v1/operations/complete-file-creation/displayName.md similarity index 100% rename from services/storage/v1/operations/complete-file-creation/displayName.md rename to apis/storage/v1/operations/complete-file-creation/displayName.md diff --git a/services/storage/v1/operations/create-file/description.md b/apis/storage/v1/operations/create-file/description.md similarity index 100% rename from services/storage/v1/operations/create-file/description.md rename to apis/storage/v1/operations/create-file/description.md diff --git a/services/storage/v1/operations/create-file/displayName.md b/apis/storage/v1/operations/create-file/displayName.md similarity index 100% rename from services/storage/v1/operations/create-file/displayName.md rename to apis/storage/v1/operations/create-file/displayName.md diff --git a/services/storage/v1/operations/create-folder/description.md b/apis/storage/v1/operations/create-folder/description.md similarity index 100% rename from services/storage/v1/operations/create-folder/description.md rename to apis/storage/v1/operations/create-folder/description.md diff --git a/services/storage/v1/operations/create-folder/displayName.md b/apis/storage/v1/operations/create-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/create-folder/displayName.md rename to apis/storage/v1/operations/create-folder/displayName.md diff --git a/services/storage/v1/operations/delete-file-from-recycle-bin/description.md b/apis/storage/v1/operations/delete-file-from-recycle-bin/description.md similarity index 100% rename from services/storage/v1/operations/delete-file-from-recycle-bin/description.md rename to apis/storage/v1/operations/delete-file-from-recycle-bin/description.md diff --git a/services/storage/v1/operations/delete-file-from-recycle-bin/displayName.md b/apis/storage/v1/operations/delete-file-from-recycle-bin/displayName.md similarity index 100% rename from services/storage/v1/operations/delete-file-from-recycle-bin/displayName.md rename to apis/storage/v1/operations/delete-file-from-recycle-bin/displayName.md diff --git a/services/storage/v1/operations/delete-file/description.md b/apis/storage/v1/operations/delete-file/description.md similarity index 100% rename from services/storage/v1/operations/delete-file/description.md rename to apis/storage/v1/operations/delete-file/description.md diff --git a/services/storage/v1/operations/delete-file/displayName.md b/apis/storage/v1/operations/delete-file/displayName.md similarity index 100% rename from services/storage/v1/operations/delete-file/displayName.md rename to apis/storage/v1/operations/delete-file/displayName.md diff --git a/services/storage/v1/operations/delete-folder-from-recycle-bin/description.md b/apis/storage/v1/operations/delete-folder-from-recycle-bin/description.md similarity index 100% rename from services/storage/v1/operations/delete-folder-from-recycle-bin/description.md rename to apis/storage/v1/operations/delete-folder-from-recycle-bin/description.md diff --git a/services/storage/v1/operations/delete-folder-from-recycle-bin/displayName.md b/apis/storage/v1/operations/delete-folder-from-recycle-bin/displayName.md similarity index 100% rename from services/storage/v1/operations/delete-folder-from-recycle-bin/displayName.md rename to apis/storage/v1/operations/delete-folder-from-recycle-bin/displayName.md diff --git a/services/storage/v1/operations/delete-folder/description.md b/apis/storage/v1/operations/delete-folder/description.md similarity index 100% rename from services/storage/v1/operations/delete-folder/description.md rename to apis/storage/v1/operations/delete-folder/description.md diff --git a/services/storage/v1/operations/delete-folder/displayName.md b/apis/storage/v1/operations/delete-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/delete-folder/displayName.md rename to apis/storage/v1/operations/delete-folder/displayName.md diff --git a/services/storage/v1/operations/download-file/description.md b/apis/storage/v1/operations/download-file/description.md similarity index 100% rename from services/storage/v1/operations/download-file/description.md rename to apis/storage/v1/operations/download-file/description.md diff --git a/services/storage/v1/operations/download-file/displayName.md b/apis/storage/v1/operations/download-file/displayName.md similarity index 100% rename from services/storage/v1/operations/download-file/displayName.md rename to apis/storage/v1/operations/download-file/displayName.md diff --git a/services/storage/v1/operations/get-file/description.md b/apis/storage/v1/operations/get-file/description.md similarity index 100% rename from services/storage/v1/operations/get-file/description.md rename to apis/storage/v1/operations/get-file/description.md diff --git a/services/storage/v1/operations/get-file/displayName.md b/apis/storage/v1/operations/get-file/displayName.md similarity index 100% rename from services/storage/v1/operations/get-file/displayName.md rename to apis/storage/v1/operations/get-file/displayName.md diff --git a/services/storage/v1/operations/get-files-in-folder/description.md b/apis/storage/v1/operations/get-files-in-folder/description.md similarity index 100% rename from services/storage/v1/operations/get-files-in-folder/description.md rename to apis/storage/v1/operations/get-files-in-folder/description.md diff --git a/services/storage/v1/operations/get-files-in-folder/displayName.md b/apis/storage/v1/operations/get-files-in-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/get-files-in-folder/displayName.md rename to apis/storage/v1/operations/get-files-in-folder/displayName.md diff --git a/services/storage/v1/operations/get-folder/description.md b/apis/storage/v1/operations/get-folder/description.md similarity index 100% rename from services/storage/v1/operations/get-folder/description.md rename to apis/storage/v1/operations/get-folder/description.md diff --git a/services/storage/v1/operations/get-folder/displayName.md b/apis/storage/v1/operations/get-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/get-folder/displayName.md rename to apis/storage/v1/operations/get-folder/displayName.md diff --git a/services/storage/v1/operations/get-folders-and-files-in-folder/description.md b/apis/storage/v1/operations/get-folders-and-files-in-folder/description.md similarity index 100% rename from services/storage/v1/operations/get-folders-and-files-in-folder/description.md rename to apis/storage/v1/operations/get-folders-and-files-in-folder/description.md diff --git a/services/storage/v1/operations/get-folders-and-files-in-folder/displayName.md b/apis/storage/v1/operations/get-folders-and-files-in-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/get-folders-and-files-in-folder/displayName.md rename to apis/storage/v1/operations/get-folders-and-files-in-folder/displayName.md diff --git a/services/storage/v1/operations/get-folders-and-files-in-recycle-bin/description.md b/apis/storage/v1/operations/get-folders-and-files-in-recycle-bin/description.md similarity index 100% rename from services/storage/v1/operations/get-folders-and-files-in-recycle-bin/description.md rename to apis/storage/v1/operations/get-folders-and-files-in-recycle-bin/description.md diff --git a/services/storage/v1/operations/get-folders-and-files-in-recycle-bin/displayName.md b/apis/storage/v1/operations/get-folders-and-files-in-recycle-bin/displayName.md similarity index 100% rename from services/storage/v1/operations/get-folders-and-files-in-recycle-bin/displayName.md rename to apis/storage/v1/operations/get-folders-and-files-in-recycle-bin/displayName.md diff --git a/services/storage/v1/operations/get-folders-in-folder/description.md b/apis/storage/v1/operations/get-folders-in-folder/description.md similarity index 100% rename from services/storage/v1/operations/get-folders-in-folder/description.md rename to apis/storage/v1/operations/get-folders-in-folder/description.md diff --git a/services/storage/v1/operations/get-folders-in-folder/displayName.md b/apis/storage/v1/operations/get-folders-in-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/get-folders-in-folder/displayName.md rename to apis/storage/v1/operations/get-folders-in-folder/displayName.md diff --git a/services/storage/v1/operations/get-top-level-folders-and-files-by-project/description.md b/apis/storage/v1/operations/get-top-level-folders-and-files-by-project/description.md similarity index 100% rename from services/storage/v1/operations/get-top-level-folders-and-files-by-project/description.md rename to apis/storage/v1/operations/get-top-level-folders-and-files-by-project/description.md diff --git a/services/storage/v1/operations/get-top-level-folders-and-files-by-project/displayName.md b/apis/storage/v1/operations/get-top-level-folders-and-files-by-project/displayName.md similarity index 100% rename from services/storage/v1/operations/get-top-level-folders-and-files-by-project/displayName.md rename to apis/storage/v1/operations/get-top-level-folders-and-files-by-project/displayName.md diff --git a/services/storage/v1/operations/lock-files-in-folder/description.md b/apis/storage/v1/operations/lock-files-in-folder/description.md similarity index 100% rename from services/storage/v1/operations/lock-files-in-folder/description.md rename to apis/storage/v1/operations/lock-files-in-folder/description.md diff --git a/services/storage/v1/operations/lock-files-in-folder/displayName.md b/apis/storage/v1/operations/lock-files-in-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/lock-files-in-folder/displayName.md rename to apis/storage/v1/operations/lock-files-in-folder/displayName.md diff --git a/services/storage/v1/operations/move-file-legacy/description.md b/apis/storage/v1/operations/move-file-legacy/description.md similarity index 100% rename from services/storage/v1/operations/move-file-legacy/description.md rename to apis/storage/v1/operations/move-file-legacy/description.md diff --git a/services/storage/v1/operations/move-file-legacy/displayName.md b/apis/storage/v1/operations/move-file-legacy/displayName.md similarity index 100% rename from services/storage/v1/operations/move-file-legacy/displayName.md rename to apis/storage/v1/operations/move-file-legacy/displayName.md diff --git a/services/storage/v1/operations/move-file/description.md b/apis/storage/v1/operations/move-file/description.md similarity index 100% rename from services/storage/v1/operations/move-file/description.md rename to apis/storage/v1/operations/move-file/description.md diff --git a/services/storage/v1/operations/move-file/displayName.md b/apis/storage/v1/operations/move-file/displayName.md similarity index 100% rename from services/storage/v1/operations/move-file/displayName.md rename to apis/storage/v1/operations/move-file/displayName.md diff --git a/services/storage/v1/operations/move-folder/description.md b/apis/storage/v1/operations/move-folder/description.md similarity index 100% rename from services/storage/v1/operations/move-folder/description.md rename to apis/storage/v1/operations/move-folder/description.md diff --git a/services/storage/v1/operations/move-folder/displayName.md b/apis/storage/v1/operations/move-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/move-folder/displayName.md rename to apis/storage/v1/operations/move-folder/displayName.md diff --git a/services/storage/v1/operations/restore-file/description.md b/apis/storage/v1/operations/restore-file/description.md similarity index 100% rename from services/storage/v1/operations/restore-file/description.md rename to apis/storage/v1/operations/restore-file/description.md diff --git a/services/storage/v1/operations/restore-file/displayName.md b/apis/storage/v1/operations/restore-file/displayName.md similarity index 100% rename from services/storage/v1/operations/restore-file/displayName.md rename to apis/storage/v1/operations/restore-file/displayName.md diff --git a/services/storage/v1/operations/restore-folder/description.md b/apis/storage/v1/operations/restore-folder/description.md similarity index 100% rename from services/storage/v1/operations/restore-folder/description.md rename to apis/storage/v1/operations/restore-folder/description.md diff --git a/services/storage/v1/operations/restore-folder/displayName.md b/apis/storage/v1/operations/restore-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/restore-folder/displayName.md rename to apis/storage/v1/operations/restore-folder/displayName.md diff --git a/services/storage/v1/operations/search-for-folders-and-files-in-folder/description.md b/apis/storage/v1/operations/search-for-folders-and-files-in-folder/description.md similarity index 100% rename from services/storage/v1/operations/search-for-folders-and-files-in-folder/description.md rename to apis/storage/v1/operations/search-for-folders-and-files-in-folder/description.md diff --git a/services/storage/v1/operations/search-for-folders-and-files-in-folder/displayName.md b/apis/storage/v1/operations/search-for-folders-and-files-in-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/search-for-folders-and-files-in-folder/displayName.md rename to apis/storage/v1/operations/search-for-folders-and-files-in-folder/displayName.md diff --git a/services/storage/v1/operations/unlock-files-in-folder/description.md b/apis/storage/v1/operations/unlock-files-in-folder/description.md similarity index 100% rename from services/storage/v1/operations/unlock-files-in-folder/description.md rename to apis/storage/v1/operations/unlock-files-in-folder/description.md diff --git a/services/storage/v1/operations/unlock-files-in-folder/displayName.md b/apis/storage/v1/operations/unlock-files-in-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/unlock-files-in-folder/displayName.md rename to apis/storage/v1/operations/unlock-files-in-folder/displayName.md diff --git a/services/storage/v1/operations/update-file-content/description.md b/apis/storage/v1/operations/update-file-content/description.md similarity index 100% rename from services/storage/v1/operations/update-file-content/description.md rename to apis/storage/v1/operations/update-file-content/description.md diff --git a/services/storage/v1/operations/update-file-content/displayName.md b/apis/storage/v1/operations/update-file-content/displayName.md similarity index 100% rename from services/storage/v1/operations/update-file-content/displayName.md rename to apis/storage/v1/operations/update-file-content/displayName.md diff --git a/services/storage/v1/operations/update-file/description.md b/apis/storage/v1/operations/update-file/description.md similarity index 100% rename from services/storage/v1/operations/update-file/description.md rename to apis/storage/v1/operations/update-file/description.md diff --git a/services/storage/v1/operations/update-file/displayName.md b/apis/storage/v1/operations/update-file/displayName.md similarity index 100% rename from services/storage/v1/operations/update-file/displayName.md rename to apis/storage/v1/operations/update-file/displayName.md diff --git a/services/storage/v1/operations/update-folder/description.md b/apis/storage/v1/operations/update-folder/description.md similarity index 100% rename from services/storage/v1/operations/update-folder/description.md rename to apis/storage/v1/operations/update-folder/description.md diff --git a/services/storage/v1/operations/update-folder/displayName.md b/apis/storage/v1/operations/update-folder/displayName.md similarity index 100% rename from services/storage/v1/operations/update-folder/displayName.md rename to apis/storage/v1/operations/update-folder/displayName.md diff --git a/services/synchronization/v1/description.md b/apis/synchronization/v1/description.md similarity index 100% rename from services/synchronization/v1/description.md rename to apis/synchronization/v1/description.md diff --git a/services/synchronization/v1/operations/add-manifest-connection-sourcefile/description.md b/apis/synchronization/v1/operations/add-manifest-connection-sourcefile/description.md similarity index 100% rename from services/synchronization/v1/operations/add-manifest-connection-sourcefile/description.md rename to apis/synchronization/v1/operations/add-manifest-connection-sourcefile/description.md diff --git a/services/synchronization/v1/operations/add-manifest-connection-sourcefile/displayName.md b/apis/synchronization/v1/operations/add-manifest-connection-sourcefile/displayName.md similarity index 100% rename from services/synchronization/v1/operations/add-manifest-connection-sourcefile/displayName.md rename to apis/synchronization/v1/operations/add-manifest-connection-sourcefile/displayName.md diff --git a/services/synchronization/v1/operations/add-storage-connection-sourcefile/description.md b/apis/synchronization/v1/operations/add-storage-connection-sourcefile/description.md similarity index 100% rename from services/synchronization/v1/operations/add-storage-connection-sourcefile/description.md rename to apis/synchronization/v1/operations/add-storage-connection-sourcefile/description.md diff --git a/services/synchronization/v1/operations/add-storage-connection-sourcefile/displayName.md b/apis/synchronization/v1/operations/add-storage-connection-sourcefile/displayName.md similarity index 100% rename from services/synchronization/v1/operations/add-storage-connection-sourcefile/displayName.md rename to apis/synchronization/v1/operations/add-storage-connection-sourcefile/displayName.md diff --git a/services/synchronization/v1/operations/create-connection-configuration/description.md b/apis/synchronization/v1/operations/create-connection-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/create-connection-configuration/description.md rename to apis/synchronization/v1/operations/create-connection-configuration/description.md diff --git a/services/synchronization/v1/operations/create-connection-configuration/displayName.md b/apis/synchronization/v1/operations/create-connection-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/create-connection-configuration/displayName.md rename to apis/synchronization/v1/operations/create-connection-configuration/displayName.md diff --git a/services/synchronization/v1/operations/create-imodel-configuration/description.md b/apis/synchronization/v1/operations/create-imodel-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/create-imodel-configuration/description.md rename to apis/synchronization/v1/operations/create-imodel-configuration/description.md diff --git a/services/synchronization/v1/operations/create-imodel-configuration/displayName.md b/apis/synchronization/v1/operations/create-imodel-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/create-imodel-configuration/displayName.md rename to apis/synchronization/v1/operations/create-imodel-configuration/displayName.md diff --git a/services/synchronization/v1/operations/create-itwin-configuration/description.md b/apis/synchronization/v1/operations/create-itwin-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/create-itwin-configuration/description.md rename to apis/synchronization/v1/operations/create-itwin-configuration/description.md diff --git a/services/synchronization/v1/operations/create-itwin-configuration/displayName.md b/apis/synchronization/v1/operations/create-itwin-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/create-itwin-configuration/displayName.md rename to apis/synchronization/v1/operations/create-itwin-configuration/displayName.md diff --git a/services/synchronization/v1/operations/create-manifest-connection-run/description.md b/apis/synchronization/v1/operations/create-manifest-connection-run/description.md similarity index 100% rename from services/synchronization/v1/operations/create-manifest-connection-run/description.md rename to apis/synchronization/v1/operations/create-manifest-connection-run/description.md diff --git a/services/synchronization/v1/operations/create-manifest-connection-run/displayName.md b/apis/synchronization/v1/operations/create-manifest-connection-run/displayName.md similarity index 100% rename from services/synchronization/v1/operations/create-manifest-connection-run/displayName.md rename to apis/synchronization/v1/operations/create-manifest-connection-run/displayName.md diff --git a/services/synchronization/v1/operations/create-manifest-connection/description.md b/apis/synchronization/v1/operations/create-manifest-connection/description.md similarity index 100% rename from services/synchronization/v1/operations/create-manifest-connection/description.md rename to apis/synchronization/v1/operations/create-manifest-connection/description.md diff --git a/services/synchronization/v1/operations/create-manifest-connection/displayName.md b/apis/synchronization/v1/operations/create-manifest-connection/displayName.md similarity index 100% rename from services/synchronization/v1/operations/create-manifest-connection/displayName.md rename to apis/synchronization/v1/operations/create-manifest-connection/displayName.md diff --git a/services/synchronization/v1/operations/create-storage-connection/description.md b/apis/synchronization/v1/operations/create-storage-connection/description.md similarity index 100% rename from services/synchronization/v1/operations/create-storage-connection/description.md rename to apis/synchronization/v1/operations/create-storage-connection/description.md diff --git a/services/synchronization/v1/operations/create-storage-connection/displayName.md b/apis/synchronization/v1/operations/create-storage-connection/displayName.md similarity index 100% rename from services/synchronization/v1/operations/create-storage-connection/displayName.md rename to apis/synchronization/v1/operations/create-storage-connection/displayName.md diff --git a/services/synchronization/v1/operations/delete-connection-configuration/description.md b/apis/synchronization/v1/operations/delete-connection-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/delete-connection-configuration/description.md rename to apis/synchronization/v1/operations/delete-connection-configuration/description.md diff --git a/services/synchronization/v1/operations/delete-connection-configuration/displayName.md b/apis/synchronization/v1/operations/delete-connection-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/delete-connection-configuration/displayName.md rename to apis/synchronization/v1/operations/delete-connection-configuration/displayName.md diff --git a/services/synchronization/v1/operations/delete-imodel-configuration/description.md b/apis/synchronization/v1/operations/delete-imodel-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/delete-imodel-configuration/description.md rename to apis/synchronization/v1/operations/delete-imodel-configuration/description.md diff --git a/services/synchronization/v1/operations/delete-imodel-configuration/displayName.md b/apis/synchronization/v1/operations/delete-imodel-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/delete-imodel-configuration/displayName.md rename to apis/synchronization/v1/operations/delete-imodel-configuration/displayName.md diff --git a/services/synchronization/v1/operations/delete-itwin-configuration/description.md b/apis/synchronization/v1/operations/delete-itwin-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/delete-itwin-configuration/description.md rename to apis/synchronization/v1/operations/delete-itwin-configuration/description.md diff --git a/services/synchronization/v1/operations/delete-itwin-configuration/displayName.md b/apis/synchronization/v1/operations/delete-itwin-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/delete-itwin-configuration/displayName.md rename to apis/synchronization/v1/operations/delete-itwin-configuration/displayName.md diff --git a/services/synchronization/v1/operations/delete-manifest-connection/description.md b/apis/synchronization/v1/operations/delete-manifest-connection/description.md similarity index 100% rename from services/synchronization/v1/operations/delete-manifest-connection/description.md rename to apis/synchronization/v1/operations/delete-manifest-connection/description.md diff --git a/services/synchronization/v1/operations/delete-manifest-connection/displayName.md b/apis/synchronization/v1/operations/delete-manifest-connection/displayName.md similarity index 100% rename from services/synchronization/v1/operations/delete-manifest-connection/displayName.md rename to apis/synchronization/v1/operations/delete-manifest-connection/displayName.md diff --git a/services/synchronization/v1/operations/delete-storage-connection/description.md b/apis/synchronization/v1/operations/delete-storage-connection/description.md similarity index 100% rename from services/synchronization/v1/operations/delete-storage-connection/description.md rename to apis/synchronization/v1/operations/delete-storage-connection/description.md diff --git a/services/synchronization/v1/operations/delete-storage-connection/displayName.md b/apis/synchronization/v1/operations/delete-storage-connection/displayName.md similarity index 100% rename from services/synchronization/v1/operations/delete-storage-connection/displayName.md rename to apis/synchronization/v1/operations/delete-storage-connection/displayName.md diff --git a/services/synchronization/v1/operations/get-authorization-information/description.md b/apis/synchronization/v1/operations/get-authorization-information/description.md similarity index 100% rename from services/synchronization/v1/operations/get-authorization-information/description.md rename to apis/synchronization/v1/operations/get-authorization-information/description.md diff --git a/services/synchronization/v1/operations/get-authorization-information/displayName.md b/apis/synchronization/v1/operations/get-authorization-information/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-authorization-information/displayName.md rename to apis/synchronization/v1/operations/get-authorization-information/displayName.md diff --git a/services/synchronization/v1/operations/get-connection-configuration/description.md b/apis/synchronization/v1/operations/get-connection-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/get-connection-configuration/description.md rename to apis/synchronization/v1/operations/get-connection-configuration/description.md diff --git a/services/synchronization/v1/operations/get-connection-configuration/displayName.md b/apis/synchronization/v1/operations/get-connection-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-connection-configuration/displayName.md rename to apis/synchronization/v1/operations/get-connection-configuration/displayName.md diff --git a/services/synchronization/v1/operations/get-connections/description.md b/apis/synchronization/v1/operations/get-connections/description.md similarity index 100% rename from services/synchronization/v1/operations/get-connections/description.md rename to apis/synchronization/v1/operations/get-connections/description.md diff --git a/services/synchronization/v1/operations/get-connections/displayName.md b/apis/synchronization/v1/operations/get-connections/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-connections/displayName.md rename to apis/synchronization/v1/operations/get-connections/displayName.md diff --git a/services/synchronization/v1/operations/get-imodel-configuration/description.md b/apis/synchronization/v1/operations/get-imodel-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/get-imodel-configuration/description.md rename to apis/synchronization/v1/operations/get-imodel-configuration/description.md diff --git a/services/synchronization/v1/operations/get-imodel-configuration/displayName.md b/apis/synchronization/v1/operations/get-imodel-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-imodel-configuration/displayName.md rename to apis/synchronization/v1/operations/get-imodel-configuration/displayName.md diff --git a/services/synchronization/v1/operations/get-itwin-configuration/description.md b/apis/synchronization/v1/operations/get-itwin-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/get-itwin-configuration/description.md rename to apis/synchronization/v1/operations/get-itwin-configuration/description.md diff --git a/services/synchronization/v1/operations/get-itwin-configuration/displayName.md b/apis/synchronization/v1/operations/get-itwin-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-itwin-configuration/displayName.md rename to apis/synchronization/v1/operations/get-itwin-configuration/displayName.md diff --git a/services/synchronization/v1/operations/get-manifest-connection-run/description.md b/apis/synchronization/v1/operations/get-manifest-connection-run/description.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connection-run/description.md rename to apis/synchronization/v1/operations/get-manifest-connection-run/description.md diff --git a/services/synchronization/v1/operations/get-manifest-connection-run/displayName.md b/apis/synchronization/v1/operations/get-manifest-connection-run/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connection-run/displayName.md rename to apis/synchronization/v1/operations/get-manifest-connection-run/displayName.md diff --git a/services/synchronization/v1/operations/get-manifest-connection-runs/description.md b/apis/synchronization/v1/operations/get-manifest-connection-runs/description.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connection-runs/description.md rename to apis/synchronization/v1/operations/get-manifest-connection-runs/description.md diff --git a/services/synchronization/v1/operations/get-manifest-connection-runs/displayName.md b/apis/synchronization/v1/operations/get-manifest-connection-runs/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connection-runs/displayName.md rename to apis/synchronization/v1/operations/get-manifest-connection-runs/displayName.md diff --git a/services/synchronization/v1/operations/get-manifest-connection-sourcefile/description.md b/apis/synchronization/v1/operations/get-manifest-connection-sourcefile/description.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connection-sourcefile/description.md rename to apis/synchronization/v1/operations/get-manifest-connection-sourcefile/description.md diff --git a/services/synchronization/v1/operations/get-manifest-connection-sourcefile/displayName.md b/apis/synchronization/v1/operations/get-manifest-connection-sourcefile/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connection-sourcefile/displayName.md rename to apis/synchronization/v1/operations/get-manifest-connection-sourcefile/displayName.md diff --git a/services/synchronization/v1/operations/get-manifest-connection-sourcefiles/description.md b/apis/synchronization/v1/operations/get-manifest-connection-sourcefiles/description.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connection-sourcefiles/description.md rename to apis/synchronization/v1/operations/get-manifest-connection-sourcefiles/description.md diff --git a/services/synchronization/v1/operations/get-manifest-connection-sourcefiles/displayName.md b/apis/synchronization/v1/operations/get-manifest-connection-sourcefiles/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connection-sourcefiles/displayName.md rename to apis/synchronization/v1/operations/get-manifest-connection-sourcefiles/displayName.md diff --git a/services/synchronization/v1/operations/get-manifest-connection/description.md b/apis/synchronization/v1/operations/get-manifest-connection/description.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connection/description.md rename to apis/synchronization/v1/operations/get-manifest-connection/description.md diff --git a/services/synchronization/v1/operations/get-manifest-connection/displayName.md b/apis/synchronization/v1/operations/get-manifest-connection/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connection/displayName.md rename to apis/synchronization/v1/operations/get-manifest-connection/displayName.md diff --git a/services/synchronization/v1/operations/get-manifest-connections/description.md b/apis/synchronization/v1/operations/get-manifest-connections/description.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connections/description.md rename to apis/synchronization/v1/operations/get-manifest-connections/description.md diff --git a/services/synchronization/v1/operations/get-manifest-connections/displayName.md b/apis/synchronization/v1/operations/get-manifest-connections/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-manifest-connections/displayName.md rename to apis/synchronization/v1/operations/get-manifest-connections/displayName.md diff --git a/services/synchronization/v1/operations/get-storage-connection-run/description.md b/apis/synchronization/v1/operations/get-storage-connection-run/description.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connection-run/description.md rename to apis/synchronization/v1/operations/get-storage-connection-run/description.md diff --git a/services/synchronization/v1/operations/get-storage-connection-run/displayName.md b/apis/synchronization/v1/operations/get-storage-connection-run/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connection-run/displayName.md rename to apis/synchronization/v1/operations/get-storage-connection-run/displayName.md diff --git a/services/synchronization/v1/operations/get-storage-connection-runs/description.md b/apis/synchronization/v1/operations/get-storage-connection-runs/description.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connection-runs/description.md rename to apis/synchronization/v1/operations/get-storage-connection-runs/description.md diff --git a/services/synchronization/v1/operations/get-storage-connection-runs/displayName.md b/apis/synchronization/v1/operations/get-storage-connection-runs/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connection-runs/displayName.md rename to apis/synchronization/v1/operations/get-storage-connection-runs/displayName.md diff --git a/services/synchronization/v1/operations/get-storage-connection-sourcefile/description.md b/apis/synchronization/v1/operations/get-storage-connection-sourcefile/description.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connection-sourcefile/description.md rename to apis/synchronization/v1/operations/get-storage-connection-sourcefile/description.md diff --git a/services/synchronization/v1/operations/get-storage-connection-sourcefile/displayName.md b/apis/synchronization/v1/operations/get-storage-connection-sourcefile/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connection-sourcefile/displayName.md rename to apis/synchronization/v1/operations/get-storage-connection-sourcefile/displayName.md diff --git a/services/synchronization/v1/operations/get-storage-connection-sourcefiles/description.md b/apis/synchronization/v1/operations/get-storage-connection-sourcefiles/description.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connection-sourcefiles/description.md rename to apis/synchronization/v1/operations/get-storage-connection-sourcefiles/description.md diff --git a/services/synchronization/v1/operations/get-storage-connection-sourcefiles/displayName.md b/apis/synchronization/v1/operations/get-storage-connection-sourcefiles/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connection-sourcefiles/displayName.md rename to apis/synchronization/v1/operations/get-storage-connection-sourcefiles/displayName.md diff --git a/services/synchronization/v1/operations/get-storage-connection/description.md b/apis/synchronization/v1/operations/get-storage-connection/description.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connection/description.md rename to apis/synchronization/v1/operations/get-storage-connection/description.md diff --git a/services/synchronization/v1/operations/get-storage-connection/displayName.md b/apis/synchronization/v1/operations/get-storage-connection/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connection/displayName.md rename to apis/synchronization/v1/operations/get-storage-connection/displayName.md diff --git a/services/synchronization/v1/operations/get-storage-connections/description.md b/apis/synchronization/v1/operations/get-storage-connections/description.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connections/description.md rename to apis/synchronization/v1/operations/get-storage-connections/description.md diff --git a/services/synchronization/v1/operations/get-storage-connections/displayName.md b/apis/synchronization/v1/operations/get-storage-connections/displayName.md similarity index 100% rename from services/synchronization/v1/operations/get-storage-connections/displayName.md rename to apis/synchronization/v1/operations/get-storage-connections/displayName.md diff --git a/services/synchronization/v1/operations/patch-connection-configuration/description.md b/apis/synchronization/v1/operations/patch-connection-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/patch-connection-configuration/description.md rename to apis/synchronization/v1/operations/patch-connection-configuration/description.md diff --git a/services/synchronization/v1/operations/patch-connection-configuration/displayName.md b/apis/synchronization/v1/operations/patch-connection-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/patch-connection-configuration/displayName.md rename to apis/synchronization/v1/operations/patch-connection-configuration/displayName.md diff --git a/services/synchronization/v1/operations/patch-imodel-configuration/description.md b/apis/synchronization/v1/operations/patch-imodel-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/patch-imodel-configuration/description.md rename to apis/synchronization/v1/operations/patch-imodel-configuration/description.md diff --git a/services/synchronization/v1/operations/patch-imodel-configuration/displayName.md b/apis/synchronization/v1/operations/patch-imodel-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/patch-imodel-configuration/displayName.md rename to apis/synchronization/v1/operations/patch-imodel-configuration/displayName.md diff --git a/services/synchronization/v1/operations/patch-itwin-configuration/description.md b/apis/synchronization/v1/operations/patch-itwin-configuration/description.md similarity index 100% rename from services/synchronization/v1/operations/patch-itwin-configuration/description.md rename to apis/synchronization/v1/operations/patch-itwin-configuration/description.md diff --git a/services/synchronization/v1/operations/patch-itwin-configuration/displayName.md b/apis/synchronization/v1/operations/patch-itwin-configuration/displayName.md similarity index 100% rename from services/synchronization/v1/operations/patch-itwin-configuration/displayName.md rename to apis/synchronization/v1/operations/patch-itwin-configuration/displayName.md diff --git a/services/synchronization/v1/operations/remove-manifest-connection-sourcefile/description.md b/apis/synchronization/v1/operations/remove-manifest-connection-sourcefile/description.md similarity index 100% rename from services/synchronization/v1/operations/remove-manifest-connection-sourcefile/description.md rename to apis/synchronization/v1/operations/remove-manifest-connection-sourcefile/description.md diff --git a/services/synchronization/v1/operations/remove-manifest-connection-sourcefile/displayName.md b/apis/synchronization/v1/operations/remove-manifest-connection-sourcefile/displayName.md similarity index 100% rename from services/synchronization/v1/operations/remove-manifest-connection-sourcefile/displayName.md rename to apis/synchronization/v1/operations/remove-manifest-connection-sourcefile/displayName.md diff --git a/services/synchronization/v1/operations/remove-storage-connection-sourcefile/description.md b/apis/synchronization/v1/operations/remove-storage-connection-sourcefile/description.md similarity index 100% rename from services/synchronization/v1/operations/remove-storage-connection-sourcefile/description.md rename to apis/synchronization/v1/operations/remove-storage-connection-sourcefile/description.md diff --git a/services/synchronization/v1/operations/remove-storage-connection-sourcefile/displayName.md b/apis/synchronization/v1/operations/remove-storage-connection-sourcefile/displayName.md similarity index 100% rename from services/synchronization/v1/operations/remove-storage-connection-sourcefile/displayName.md rename to apis/synchronization/v1/operations/remove-storage-connection-sourcefile/displayName.md diff --git a/services/synchronization/v1/operations/run-storage-connection/description.md b/apis/synchronization/v1/operations/run-storage-connection/description.md similarity index 100% rename from services/synchronization/v1/operations/run-storage-connection/description.md rename to apis/synchronization/v1/operations/run-storage-connection/description.md diff --git a/services/synchronization/v1/operations/run-storage-connection/displayName.md b/apis/synchronization/v1/operations/run-storage-connection/displayName.md similarity index 100% rename from services/synchronization/v1/operations/run-storage-connection/displayName.md rename to apis/synchronization/v1/operations/run-storage-connection/displayName.md diff --git a/services/synchronization/v1/operations/update-manifest-connection-sourcefile/description.md b/apis/synchronization/v1/operations/update-manifest-connection-sourcefile/description.md similarity index 100% rename from services/synchronization/v1/operations/update-manifest-connection-sourcefile/description.md rename to apis/synchronization/v1/operations/update-manifest-connection-sourcefile/description.md diff --git a/services/synchronization/v1/operations/update-manifest-connection-sourcefile/displayName.md b/apis/synchronization/v1/operations/update-manifest-connection-sourcefile/displayName.md similarity index 100% rename from services/synchronization/v1/operations/update-manifest-connection-sourcefile/displayName.md rename to apis/synchronization/v1/operations/update-manifest-connection-sourcefile/displayName.md diff --git a/services/synchronization/v1/operations/update-manifest-connection/description.md b/apis/synchronization/v1/operations/update-manifest-connection/description.md similarity index 100% rename from services/synchronization/v1/operations/update-manifest-connection/description.md rename to apis/synchronization/v1/operations/update-manifest-connection/description.md diff --git a/services/synchronization/v1/operations/update-manifest-connection/displayName.md b/apis/synchronization/v1/operations/update-manifest-connection/displayName.md similarity index 100% rename from services/synchronization/v1/operations/update-manifest-connection/displayName.md rename to apis/synchronization/v1/operations/update-manifest-connection/displayName.md diff --git a/services/synchronization/v1/operations/update-storage-connection-sourcefile/description.md b/apis/synchronization/v1/operations/update-storage-connection-sourcefile/description.md similarity index 100% rename from services/synchronization/v1/operations/update-storage-connection-sourcefile/description.md rename to apis/synchronization/v1/operations/update-storage-connection-sourcefile/description.md diff --git a/services/synchronization/v1/operations/update-storage-connection-sourcefile/displayName.md b/apis/synchronization/v1/operations/update-storage-connection-sourcefile/displayName.md similarity index 100% rename from services/synchronization/v1/operations/update-storage-connection-sourcefile/displayName.md rename to apis/synchronization/v1/operations/update-storage-connection-sourcefile/displayName.md diff --git a/services/synchronization/v1/operations/update-storage-connection/description.md b/apis/synchronization/v1/operations/update-storage-connection/description.md similarity index 100% rename from services/synchronization/v1/operations/update-storage-connection/description.md rename to apis/synchronization/v1/operations/update-storage-connection/description.md diff --git a/services/synchronization/v1/operations/update-storage-connection/displayName.md b/apis/synchronization/v1/operations/update-storage-connection/displayName.md similarity index 100% rename from services/synchronization/v1/operations/update-storage-connection/displayName.md rename to apis/synchronization/v1/operations/update-storage-connection/displayName.md diff --git a/services/transformations/v1/description.md b/apis/transformations/v1/description.md similarity index 100% rename from services/transformations/v1/description.md rename to apis/transformations/v1/description.md diff --git a/services/transformations/v1/operations/alignimodeldata/description.md b/apis/transformations/v1/operations/alignimodeldata/description.md similarity index 100% rename from services/transformations/v1/operations/alignimodeldata/description.md rename to apis/transformations/v1/operations/alignimodeldata/description.md diff --git a/services/transformations/v1/operations/alignimodeldata/displayName.md b/apis/transformations/v1/operations/alignimodeldata/displayName.md similarity index 100% rename from services/transformations/v1/operations/alignimodeldata/displayName.md rename to apis/transformations/v1/operations/alignimodeldata/displayName.md diff --git a/services/transformations/v1/operations/combineimodels/description.md b/apis/transformations/v1/operations/combineimodels/description.md similarity index 100% rename from services/transformations/v1/operations/combineimodels/description.md rename to apis/transformations/v1/operations/combineimodels/description.md diff --git a/services/transformations/v1/operations/combineimodels/displayName.md b/apis/transformations/v1/operations/combineimodels/displayName.md similarity index 100% rename from services/transformations/v1/operations/combineimodels/displayName.md rename to apis/transformations/v1/operations/combineimodels/displayName.md diff --git a/services/transformations/v1/operations/combinephysicalmodels/description.md b/apis/transformations/v1/operations/combinephysicalmodels/description.md similarity index 100% rename from services/transformations/v1/operations/combinephysicalmodels/description.md rename to apis/transformations/v1/operations/combinephysicalmodels/description.md diff --git a/services/transformations/v1/operations/combinephysicalmodels/displayName.md b/apis/transformations/v1/operations/combinephysicalmodels/displayName.md similarity index 100% rename from services/transformations/v1/operations/combinephysicalmodels/displayName.md rename to apis/transformations/v1/operations/combinephysicalmodels/displayName.md diff --git a/services/transformations/v1/operations/combinephysicalmodelsv2/description.md b/apis/transformations/v1/operations/combinephysicalmodelsv2/description.md similarity index 100% rename from services/transformations/v1/operations/combinephysicalmodelsv2/description.md rename to apis/transformations/v1/operations/combinephysicalmodelsv2/description.md diff --git a/services/transformations/v1/operations/combinephysicalmodelsv2/displayName.md b/apis/transformations/v1/operations/combinephysicalmodelsv2/displayName.md similarity index 100% rename from services/transformations/v1/operations/combinephysicalmodelsv2/displayName.md rename to apis/transformations/v1/operations/combinephysicalmodelsv2/displayName.md diff --git a/services/transformations/v1/operations/create-transformation/description.md b/apis/transformations/v1/operations/create-transformation/description.md similarity index 100% rename from services/transformations/v1/operations/create-transformation/description.md rename to apis/transformations/v1/operations/create-transformation/description.md diff --git a/services/transformations/v1/operations/create-transformation/displayName.md b/apis/transformations/v1/operations/create-transformation/displayName.md similarity index 100% rename from services/transformations/v1/operations/create-transformation/displayName.md rename to apis/transformations/v1/operations/create-transformation/displayName.md diff --git a/services/transformations/v1/operations/createfork/description.md b/apis/transformations/v1/operations/createfork/description.md similarity index 100% rename from services/transformations/v1/operations/createfork/description.md rename to apis/transformations/v1/operations/createfork/description.md diff --git a/services/transformations/v1/operations/createfork/displayName.md b/apis/transformations/v1/operations/createfork/displayName.md similarity index 100% rename from services/transformations/v1/operations/createfork/displayName.md rename to apis/transformations/v1/operations/createfork/displayName.md diff --git a/services/transformations/v1/operations/delete-configuration/description.md b/apis/transformations/v1/operations/delete-configuration/description.md similarity index 100% rename from services/transformations/v1/operations/delete-configuration/description.md rename to apis/transformations/v1/operations/delete-configuration/description.md diff --git a/services/transformations/v1/operations/delete-configuration/displayName.md b/apis/transformations/v1/operations/delete-configuration/displayName.md similarity index 100% rename from services/transformations/v1/operations/delete-configuration/displayName.md rename to apis/transformations/v1/operations/delete-configuration/displayName.md diff --git a/services/transformations/v1/operations/delete-transformation/description.md b/apis/transformations/v1/operations/delete-transformation/description.md similarity index 100% rename from services/transformations/v1/operations/delete-transformation/description.md rename to apis/transformations/v1/operations/delete-transformation/description.md diff --git a/services/transformations/v1/operations/delete-transformation/displayName.md b/apis/transformations/v1/operations/delete-transformation/displayName.md similarity index 100% rename from services/transformations/v1/operations/delete-transformation/displayName.md rename to apis/transformations/v1/operations/delete-transformation/displayName.md diff --git a/services/transformations/v1/operations/filterbyviewdefinition/description.md b/apis/transformations/v1/operations/filterbyviewdefinition/description.md similarity index 100% rename from services/transformations/v1/operations/filterbyviewdefinition/description.md rename to apis/transformations/v1/operations/filterbyviewdefinition/description.md diff --git a/services/transformations/v1/operations/filterbyviewdefinition/displayName.md b/apis/transformations/v1/operations/filterbyviewdefinition/displayName.md similarity index 100% rename from services/transformations/v1/operations/filterbyviewdefinition/displayName.md rename to apis/transformations/v1/operations/filterbyviewdefinition/displayName.md diff --git a/services/transformations/v1/operations/filterimodel/description.md b/apis/transformations/v1/operations/filterimodel/description.md similarity index 100% rename from services/transformations/v1/operations/filterimodel/description.md rename to apis/transformations/v1/operations/filterimodel/description.md diff --git a/services/transformations/v1/operations/filterimodel/displayName.md b/apis/transformations/v1/operations/filterimodel/displayName.md similarity index 100% rename from services/transformations/v1/operations/filterimodel/displayName.md rename to apis/transformations/v1/operations/filterimodel/displayName.md diff --git a/services/transformations/v1/operations/filtersubcategories/description.md b/apis/transformations/v1/operations/filtersubcategories/description.md similarity index 100% rename from services/transformations/v1/operations/filtersubcategories/description.md rename to apis/transformations/v1/operations/filtersubcategories/description.md diff --git a/services/transformations/v1/operations/filtersubcategories/displayName.md b/apis/transformations/v1/operations/filtersubcategories/displayName.md similarity index 100% rename from services/transformations/v1/operations/filtersubcategories/displayName.md rename to apis/transformations/v1/operations/filtersubcategories/displayName.md diff --git a/services/transformations/v1/operations/get-all-configurations/description.md b/apis/transformations/v1/operations/get-all-configurations/description.md similarity index 100% rename from services/transformations/v1/operations/get-all-configurations/description.md rename to apis/transformations/v1/operations/get-all-configurations/description.md diff --git a/services/transformations/v1/operations/get-all-configurations/displayName.md b/apis/transformations/v1/operations/get-all-configurations/displayName.md similarity index 100% rename from services/transformations/v1/operations/get-all-configurations/displayName.md rename to apis/transformations/v1/operations/get-all-configurations/displayName.md diff --git a/services/transformations/v1/operations/get-all-transformations/description.md b/apis/transformations/v1/operations/get-all-transformations/description.md similarity index 100% rename from services/transformations/v1/operations/get-all-transformations/description.md rename to apis/transformations/v1/operations/get-all-transformations/description.md diff --git a/services/transformations/v1/operations/get-all-transformations/displayName.md b/apis/transformations/v1/operations/get-all-transformations/displayName.md similarity index 100% rename from services/transformations/v1/operations/get-all-transformations/displayName.md rename to apis/transformations/v1/operations/get-all-transformations/displayName.md diff --git a/services/transformations/v1/operations/get-configuration/description.md b/apis/transformations/v1/operations/get-configuration/description.md similarity index 100% rename from services/transformations/v1/operations/get-configuration/description.md rename to apis/transformations/v1/operations/get-configuration/description.md diff --git a/services/transformations/v1/operations/get-configuration/displayName.md b/apis/transformations/v1/operations/get-configuration/displayName.md similarity index 100% rename from services/transformations/v1/operations/get-configuration/displayName.md rename to apis/transformations/v1/operations/get-configuration/displayName.md diff --git a/services/transformations/v1/operations/get-transformation/description.md b/apis/transformations/v1/operations/get-transformation/description.md similarity index 100% rename from services/transformations/v1/operations/get-transformation/description.md rename to apis/transformations/v1/operations/get-transformation/description.md diff --git a/services/transformations/v1/operations/get-transformation/displayName.md b/apis/transformations/v1/operations/get-transformation/displayName.md similarity index 100% rename from services/transformations/v1/operations/get-transformation/displayName.md rename to apis/transformations/v1/operations/get-transformation/displayName.md diff --git a/services/transformations/v1/operations/groupandmap/description.md b/apis/transformations/v1/operations/groupandmap/description.md similarity index 100% rename from services/transformations/v1/operations/groupandmap/description.md rename to apis/transformations/v1/operations/groupandmap/description.md diff --git a/services/transformations/v1/operations/groupandmap/displayName.md b/apis/transformations/v1/operations/groupandmap/displayName.md similarity index 100% rename from services/transformations/v1/operations/groupandmap/displayName.md rename to apis/transformations/v1/operations/groupandmap/displayName.md diff --git a/services/transformations/v1/operations/importimodel/description.md b/apis/transformations/v1/operations/importimodel/description.md similarity index 100% rename from services/transformations/v1/operations/importimodel/description.md rename to apis/transformations/v1/operations/importimodel/description.md diff --git a/services/transformations/v1/operations/importimodel/displayName.md b/apis/transformations/v1/operations/importimodel/displayName.md similarity index 100% rename from services/transformations/v1/operations/importimodel/displayName.md rename to apis/transformations/v1/operations/importimodel/displayName.md diff --git a/services/transformations/v1/operations/mergefork/description.md b/apis/transformations/v1/operations/mergefork/description.md similarity index 100% rename from services/transformations/v1/operations/mergefork/description.md rename to apis/transformations/v1/operations/mergefork/description.md diff --git a/services/transformations/v1/operations/mergefork/displayName.md b/apis/transformations/v1/operations/mergefork/displayName.md similarity index 100% rename from services/transformations/v1/operations/mergefork/displayName.md rename to apis/transformations/v1/operations/mergefork/displayName.md diff --git a/services/transformations/v1/operations/mergeimodel/description.md b/apis/transformations/v1/operations/mergeimodel/description.md similarity index 100% rename from services/transformations/v1/operations/mergeimodel/description.md rename to apis/transformations/v1/operations/mergeimodel/description.md diff --git a/services/transformations/v1/operations/mergeimodel/displayName.md b/apis/transformations/v1/operations/mergeimodel/displayName.md similarity index 100% rename from services/transformations/v1/operations/mergeimodel/displayName.md rename to apis/transformations/v1/operations/mergeimodel/displayName.md diff --git a/services/transformations/v1/operations/populatefederationguids/description.md b/apis/transformations/v1/operations/populatefederationguids/description.md similarity index 100% rename from services/transformations/v1/operations/populatefederationguids/description.md rename to apis/transformations/v1/operations/populatefederationguids/description.md diff --git a/services/transformations/v1/operations/populatefederationguids/displayName.md b/apis/transformations/v1/operations/populatefederationguids/displayName.md similarity index 100% rename from services/transformations/v1/operations/populatefederationguids/displayName.md rename to apis/transformations/v1/operations/populatefederationguids/displayName.md diff --git a/services/users/v1/description.md b/apis/users/v1/description.md similarity index 100% rename from services/users/v1/description.md rename to apis/users/v1/description.md diff --git a/services/users/v1/operations/get-user/description.md b/apis/users/v1/operations/get-user/description.md similarity index 100% rename from services/users/v1/operations/get-user/description.md rename to apis/users/v1/operations/get-user/description.md diff --git a/services/users/v1/operations/get-user/displayName.md b/apis/users/v1/operations/get-user/displayName.md similarity index 100% rename from services/users/v1/operations/get-user/displayName.md rename to apis/users/v1/operations/get-user/displayName.md diff --git a/services/users/v1/operations/get-users-by-id-list/description.md b/apis/users/v1/operations/get-users-by-id-list/description.md similarity index 100% rename from services/users/v1/operations/get-users-by-id-list/description.md rename to apis/users/v1/operations/get-users-by-id-list/description.md diff --git a/services/users/v1/operations/get-users-by-id-list/displayName.md b/apis/users/v1/operations/get-users-by-id-list/displayName.md similarity index 100% rename from services/users/v1/operations/get-users-by-id-list/displayName.md rename to apis/users/v1/operations/get-users-by-id-list/displayName.md diff --git a/services/users/v1/operations/get-users/description.md b/apis/users/v1/operations/get-users/description.md similarity index 100% rename from services/users/v1/operations/get-users/description.md rename to apis/users/v1/operations/get-users/description.md diff --git a/services/users/v1/operations/get-users/displayName.md b/apis/users/v1/operations/get-users/displayName.md similarity index 100% rename from services/users/v1/operations/get-users/displayName.md rename to apis/users/v1/operations/get-users/displayName.md diff --git a/services/users/v1/operations/me/description.md b/apis/users/v1/operations/me/description.md similarity index 100% rename from services/users/v1/operations/me/description.md rename to apis/users/v1/operations/me/description.md diff --git a/services/users/v1/operations/me/displayName.md b/apis/users/v1/operations/me/displayName.md similarity index 100% rename from services/users/v1/operations/me/displayName.md rename to apis/users/v1/operations/me/displayName.md diff --git a/services/access-control/v2/description.md b/apis/v2/description.md similarity index 100% rename from services/access-control/v2/description.md rename to apis/v2/description.md diff --git a/services/access-control/v2/operations/add-itwin-group-members/description.md b/apis/v2/operations/add-itwin-group-members/description.md similarity index 100% rename from services/access-control/v2/operations/add-itwin-group-members/description.md rename to apis/v2/operations/add-itwin-group-members/description.md diff --git a/apis/v2/operations/add-itwin-group-members/displayName.md b/apis/v2/operations/add-itwin-group-members/displayName.md new file mode 100644 index 0000000..68c1b77 --- /dev/null +++ b/apis/v2/operations/add-itwin-group-members/displayName.md @@ -0,0 +1 @@ +Add iTwin group members \ No newline at end of file diff --git a/services/access-control/v2/operations/add-itwin-owner-member/description.md b/apis/v2/operations/add-itwin-owner-member/description.md similarity index 100% rename from services/access-control/v2/operations/add-itwin-owner-member/description.md rename to apis/v2/operations/add-itwin-owner-member/description.md diff --git a/apis/v2/operations/add-itwin-owner-member/displayName.md b/apis/v2/operations/add-itwin-owner-member/displayName.md new file mode 100644 index 0000000..45ee905 --- /dev/null +++ b/apis/v2/operations/add-itwin-owner-member/displayName.md @@ -0,0 +1 @@ +Add iTwin owner member \ No newline at end of file diff --git a/services/access-control/v2/operations/add-itwin-user-members/description.md b/apis/v2/operations/add-itwin-user-members/description.md similarity index 100% rename from services/access-control/v2/operations/add-itwin-user-members/description.md rename to apis/v2/operations/add-itwin-user-members/description.md diff --git a/apis/v2/operations/add-itwin-user-members/displayName.md b/apis/v2/operations/add-itwin-user-members/displayName.md new file mode 100644 index 0000000..0e28ddd --- /dev/null +++ b/apis/v2/operations/add-itwin-user-members/displayName.md @@ -0,0 +1 @@ +Add iTwin user members \ No newline at end of file diff --git a/services/access-control/v2/operations/create-iTwin-role/description.md b/apis/v2/operations/create-iTwin-role/description.md similarity index 100% rename from services/access-control/v2/operations/create-iTwin-role/description.md rename to apis/v2/operations/create-iTwin-role/description.md diff --git a/apis/v2/operations/create-iTwin-role/displayName.md b/apis/v2/operations/create-iTwin-role/displayName.md new file mode 100644 index 0000000..cd6904e --- /dev/null +++ b/apis/v2/operations/create-iTwin-role/displayName.md @@ -0,0 +1 @@ +Create iTwin role \ No newline at end of file diff --git a/services/access-control/v2/operations/create-itwin-group/description.md b/apis/v2/operations/create-itwin-group/description.md similarity index 100% rename from services/access-control/v2/operations/create-itwin-group/description.md rename to apis/v2/operations/create-itwin-group/description.md diff --git a/apis/v2/operations/create-itwin-group/displayName.md b/apis/v2/operations/create-itwin-group/displayName.md new file mode 100644 index 0000000..c9628f1 --- /dev/null +++ b/apis/v2/operations/create-itwin-group/displayName.md @@ -0,0 +1 @@ +Create iTwin group \ No newline at end of file diff --git a/services/access-control/v2/operations/create-itwin-job/description.md b/apis/v2/operations/create-itwin-job/description.md similarity index 100% rename from services/access-control/v2/operations/create-itwin-job/description.md rename to apis/v2/operations/create-itwin-job/description.md diff --git a/apis/v2/operations/create-itwin-job/displayName.md b/apis/v2/operations/create-itwin-job/displayName.md new file mode 100644 index 0000000..51f8b3e --- /dev/null +++ b/apis/v2/operations/create-itwin-job/displayName.md @@ -0,0 +1 @@ +Create iTwin job \ No newline at end of file diff --git a/services/access-control/v2/operations/delete-iTwin-role/description.md b/apis/v2/operations/delete-iTwin-role/description.md similarity index 100% rename from services/access-control/v2/operations/delete-iTwin-role/description.md rename to apis/v2/operations/delete-iTwin-role/description.md diff --git a/apis/v2/operations/delete-iTwin-role/displayName.md b/apis/v2/operations/delete-iTwin-role/displayName.md new file mode 100644 index 0000000..6792532 --- /dev/null +++ b/apis/v2/operations/delete-iTwin-role/displayName.md @@ -0,0 +1 @@ +Delete iTwin role \ No newline at end of file diff --git a/services/access-control/v2/operations/delete-itwin-group/description.md b/apis/v2/operations/delete-itwin-group/description.md similarity index 100% rename from services/access-control/v2/operations/delete-itwin-group/description.md rename to apis/v2/operations/delete-itwin-group/description.md diff --git a/apis/v2/operations/delete-itwin-group/displayName.md b/apis/v2/operations/delete-itwin-group/displayName.md new file mode 100644 index 0000000..2385fef --- /dev/null +++ b/apis/v2/operations/delete-itwin-group/displayName.md @@ -0,0 +1 @@ +Delete iTwin group \ No newline at end of file diff --git a/services/access-control/v2/operations/get-all-permissions/description.md b/apis/v2/operations/get-all-permissions/description.md similarity index 100% rename from services/access-control/v2/operations/get-all-permissions/description.md rename to apis/v2/operations/get-all-permissions/description.md diff --git a/apis/v2/operations/get-all-permissions/displayName.md b/apis/v2/operations/get-all-permissions/displayName.md new file mode 100644 index 0000000..3d98619 --- /dev/null +++ b/apis/v2/operations/get-all-permissions/displayName.md @@ -0,0 +1 @@ +Get all permissions \ No newline at end of file diff --git a/services/access-control/v2/operations/get-iTwin-permissions/description.md b/apis/v2/operations/get-iTwin-permissions/description.md similarity index 100% rename from services/access-control/v2/operations/get-iTwin-permissions/description.md rename to apis/v2/operations/get-iTwin-permissions/description.md diff --git a/apis/v2/operations/get-iTwin-permissions/displayName.md b/apis/v2/operations/get-iTwin-permissions/displayName.md new file mode 100644 index 0000000..49a6b26 --- /dev/null +++ b/apis/v2/operations/get-iTwin-permissions/displayName.md @@ -0,0 +1 @@ +Get my iTwin permissions \ No newline at end of file diff --git a/services/access-control/v2/operations/get-iTwin-roles/description.md b/apis/v2/operations/get-iTwin-roles/description.md similarity index 100% rename from services/access-control/v2/operations/get-iTwin-roles/description.md rename to apis/v2/operations/get-iTwin-roles/description.md diff --git a/apis/v2/operations/get-iTwin-roles/displayName.md b/apis/v2/operations/get-iTwin-roles/displayName.md new file mode 100644 index 0000000..5192c0f --- /dev/null +++ b/apis/v2/operations/get-iTwin-roles/displayName.md @@ -0,0 +1 @@ +Get iTwin roles \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-group-member/description.md b/apis/v2/operations/get-itwin-group-member/description.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-group-member/description.md rename to apis/v2/operations/get-itwin-group-member/description.md diff --git a/apis/v2/operations/get-itwin-group-member/displayName.md b/apis/v2/operations/get-itwin-group-member/displayName.md new file mode 100644 index 0000000..e9903b7 --- /dev/null +++ b/apis/v2/operations/get-itwin-group-member/displayName.md @@ -0,0 +1 @@ +Get iTwin group member \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-group-members/description.md b/apis/v2/operations/get-itwin-group-members/description.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-group-members/description.md rename to apis/v2/operations/get-itwin-group-members/description.md diff --git a/apis/v2/operations/get-itwin-group-members/displayName.md b/apis/v2/operations/get-itwin-group-members/displayName.md new file mode 100644 index 0000000..ebfde9f --- /dev/null +++ b/apis/v2/operations/get-itwin-group-members/displayName.md @@ -0,0 +1 @@ +Get iTwin group members \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-group/description.md b/apis/v2/operations/get-itwin-group/description.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-group/description.md rename to apis/v2/operations/get-itwin-group/description.md diff --git a/apis/v2/operations/get-itwin-group/displayName.md b/apis/v2/operations/get-itwin-group/displayName.md new file mode 100644 index 0000000..9c3cb9f --- /dev/null +++ b/apis/v2/operations/get-itwin-group/displayName.md @@ -0,0 +1 @@ +Get iTwin group \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-groups/description.md b/apis/v2/operations/get-itwin-groups/description.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-groups/description.md rename to apis/v2/operations/get-itwin-groups/description.md diff --git a/apis/v2/operations/get-itwin-groups/displayName.md b/apis/v2/operations/get-itwin-groups/displayName.md new file mode 100644 index 0000000..3b2c4d1 --- /dev/null +++ b/apis/v2/operations/get-itwin-groups/displayName.md @@ -0,0 +1 @@ +Get iTwin groups \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-job-actions/description.md b/apis/v2/operations/get-itwin-job-actions/description.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-job-actions/description.md rename to apis/v2/operations/get-itwin-job-actions/description.md diff --git a/apis/v2/operations/get-itwin-job-actions/displayName.md b/apis/v2/operations/get-itwin-job-actions/displayName.md new file mode 100644 index 0000000..6cfd93e --- /dev/null +++ b/apis/v2/operations/get-itwin-job-actions/displayName.md @@ -0,0 +1 @@ +Get iTwin job actions \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-job/description.md b/apis/v2/operations/get-itwin-job/description.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-job/description.md rename to apis/v2/operations/get-itwin-job/description.md diff --git a/apis/v2/operations/get-itwin-job/displayName.md b/apis/v2/operations/get-itwin-job/displayName.md new file mode 100644 index 0000000..3fcab99 --- /dev/null +++ b/apis/v2/operations/get-itwin-job/displayName.md @@ -0,0 +1 @@ +Get iTwin job \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-member-invitations/description.md b/apis/v2/operations/get-itwin-member-invitations/description.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-member-invitations/description.md rename to apis/v2/operations/get-itwin-member-invitations/description.md diff --git a/apis/v2/operations/get-itwin-member-invitations/displayName.md b/apis/v2/operations/get-itwin-member-invitations/displayName.md new file mode 100644 index 0000000..f6be40a --- /dev/null +++ b/apis/v2/operations/get-itwin-member-invitations/displayName.md @@ -0,0 +1 @@ +Get iTwin member invitations \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-owner-members/description.md b/apis/v2/operations/get-itwin-owner-members/description.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-owner-members/description.md rename to apis/v2/operations/get-itwin-owner-members/description.md diff --git a/apis/v2/operations/get-itwin-owner-members/displayName.md b/apis/v2/operations/get-itwin-owner-members/displayName.md new file mode 100644 index 0000000..bff08bc --- /dev/null +++ b/apis/v2/operations/get-itwin-owner-members/displayName.md @@ -0,0 +1 @@ +Get iTwin owner members \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-role/description.md b/apis/v2/operations/get-itwin-role/description.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-role/description.md rename to apis/v2/operations/get-itwin-role/description.md diff --git a/apis/v2/operations/get-itwin-role/displayName.md b/apis/v2/operations/get-itwin-role/displayName.md new file mode 100644 index 0000000..234e61f --- /dev/null +++ b/apis/v2/operations/get-itwin-role/displayName.md @@ -0,0 +1 @@ +Get iTwin role \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-user-member/description.md b/apis/v2/operations/get-itwin-user-member/description.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-user-member/description.md rename to apis/v2/operations/get-itwin-user-member/description.md diff --git a/apis/v2/operations/get-itwin-user-member/displayName.md b/apis/v2/operations/get-itwin-user-member/displayName.md new file mode 100644 index 0000000..214f53f --- /dev/null +++ b/apis/v2/operations/get-itwin-user-member/displayName.md @@ -0,0 +1 @@ +Get iTwin user member \ No newline at end of file diff --git a/services/access-control/v2/operations/get-itwin-user-members/description.md b/apis/v2/operations/get-itwin-user-members/description.md similarity index 100% rename from services/access-control/v2/operations/get-itwin-user-members/description.md rename to apis/v2/operations/get-itwin-user-members/description.md diff --git a/apis/v2/operations/get-itwin-user-members/displayName.md b/apis/v2/operations/get-itwin-user-members/displayName.md new file mode 100644 index 0000000..cafd6bd --- /dev/null +++ b/apis/v2/operations/get-itwin-user-members/displayName.md @@ -0,0 +1 @@ +Get iTwin user members \ No newline at end of file diff --git a/services/access-control/v2/operations/remove-itwin-group-member/description.md b/apis/v2/operations/remove-itwin-group-member/description.md similarity index 100% rename from services/access-control/v2/operations/remove-itwin-group-member/description.md rename to apis/v2/operations/remove-itwin-group-member/description.md diff --git a/apis/v2/operations/remove-itwin-group-member/displayName.md b/apis/v2/operations/remove-itwin-group-member/displayName.md new file mode 100644 index 0000000..b8dc5e9 --- /dev/null +++ b/apis/v2/operations/remove-itwin-group-member/displayName.md @@ -0,0 +1 @@ +Remove iTwin group member \ No newline at end of file diff --git a/services/access-control/v2/operations/remove-itwin-owner-member/description.md b/apis/v2/operations/remove-itwin-owner-member/description.md similarity index 100% rename from services/access-control/v2/operations/remove-itwin-owner-member/description.md rename to apis/v2/operations/remove-itwin-owner-member/description.md diff --git a/apis/v2/operations/remove-itwin-owner-member/displayName.md b/apis/v2/operations/remove-itwin-owner-member/displayName.md new file mode 100644 index 0000000..a2988c9 --- /dev/null +++ b/apis/v2/operations/remove-itwin-owner-member/displayName.md @@ -0,0 +1 @@ +Remove iTwin owner member \ No newline at end of file diff --git a/services/access-control/v2/operations/remove-itwin-user-member/description.md b/apis/v2/operations/remove-itwin-user-member/description.md similarity index 100% rename from services/access-control/v2/operations/remove-itwin-user-member/description.md rename to apis/v2/operations/remove-itwin-user-member/description.md diff --git a/apis/v2/operations/remove-itwin-user-member/displayName.md b/apis/v2/operations/remove-itwin-user-member/displayName.md new file mode 100644 index 0000000..bb8769f --- /dev/null +++ b/apis/v2/operations/remove-itwin-user-member/displayName.md @@ -0,0 +1 @@ +Remove iTwin user member \ No newline at end of file diff --git a/services/access-control/v2/operations/update-iTwin-role/description.md b/apis/v2/operations/update-iTwin-role/description.md similarity index 100% rename from services/access-control/v2/operations/update-iTwin-role/description.md rename to apis/v2/operations/update-iTwin-role/description.md diff --git a/apis/v2/operations/update-iTwin-role/displayName.md b/apis/v2/operations/update-iTwin-role/displayName.md new file mode 100644 index 0000000..8eae21f --- /dev/null +++ b/apis/v2/operations/update-iTwin-role/displayName.md @@ -0,0 +1 @@ +Update iTwin role \ No newline at end of file diff --git a/services/access-control/v2/operations/update-itwin-group-member/description.md b/apis/v2/operations/update-itwin-group-member/description.md similarity index 100% rename from services/access-control/v2/operations/update-itwin-group-member/description.md rename to apis/v2/operations/update-itwin-group-member/description.md diff --git a/apis/v2/operations/update-itwin-group-member/displayName.md b/apis/v2/operations/update-itwin-group-member/displayName.md new file mode 100644 index 0000000..7ffc336 --- /dev/null +++ b/apis/v2/operations/update-itwin-group-member/displayName.md @@ -0,0 +1 @@ +Update iTwin group member \ No newline at end of file diff --git a/services/access-control/v2/operations/update-itwin-group/description.md b/apis/v2/operations/update-itwin-group/description.md similarity index 100% rename from services/access-control/v2/operations/update-itwin-group/description.md rename to apis/v2/operations/update-itwin-group/description.md diff --git a/apis/v2/operations/update-itwin-group/displayName.md b/apis/v2/operations/update-itwin-group/displayName.md new file mode 100644 index 0000000..337cbad --- /dev/null +++ b/apis/v2/operations/update-itwin-group/displayName.md @@ -0,0 +1 @@ +Update iTwin group \ No newline at end of file diff --git a/services/access-control/v2/operations/update-itwin-user-member/description.md b/apis/v2/operations/update-itwin-user-member/description.md similarity index 100% rename from services/access-control/v2/operations/update-itwin-user-member/description.md rename to apis/v2/operations/update-itwin-user-member/description.md diff --git a/apis/v2/operations/update-itwin-user-member/displayName.md b/apis/v2/operations/update-itwin-user-member/displayName.md new file mode 100644 index 0000000..9bee9bb --- /dev/null +++ b/apis/v2/operations/update-itwin-user-member/displayName.md @@ -0,0 +1 @@ +Update iTwin user member \ No newline at end of file diff --git a/services/validation/v1/description.md b/apis/validation/v1/description.md similarity index 100% rename from services/validation/v1/description.md rename to apis/validation/v1/description.md diff --git a/services/validation/v1/operations/create-validation-propertyvalue-rule/description.md b/apis/validation/v1/operations/create-validation-propertyvalue-rule/description.md similarity index 100% rename from services/validation/v1/operations/create-validation-propertyvalue-rule/description.md rename to apis/validation/v1/operations/create-validation-propertyvalue-rule/description.md diff --git a/services/validation/v1/operations/create-validation-propertyvalue-rule/displayName.md b/apis/validation/v1/operations/create-validation-propertyvalue-rule/displayName.md similarity index 100% rename from services/validation/v1/operations/create-validation-propertyvalue-rule/displayName.md rename to apis/validation/v1/operations/create-validation-propertyvalue-rule/displayName.md diff --git a/services/validation/v1/operations/create-validation-propertyvalue-tests/description.md b/apis/validation/v1/operations/create-validation-propertyvalue-tests/description.md similarity index 100% rename from services/validation/v1/operations/create-validation-propertyvalue-tests/description.md rename to apis/validation/v1/operations/create-validation-propertyvalue-tests/description.md diff --git a/services/validation/v1/operations/create-validation-propertyvalue-tests/displayName.md b/apis/validation/v1/operations/create-validation-propertyvalue-tests/displayName.md similarity index 100% rename from services/validation/v1/operations/create-validation-propertyvalue-tests/displayName.md rename to apis/validation/v1/operations/create-validation-propertyvalue-tests/displayName.md diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-rule/description.md b/apis/validation/v1/operations/delete-validation-propertyvalue-rule/description.md similarity index 100% rename from services/validation/v1/operations/delete-validation-propertyvalue-rule/description.md rename to apis/validation/v1/operations/delete-validation-propertyvalue-rule/description.md diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-rule/displayName.md b/apis/validation/v1/operations/delete-validation-propertyvalue-rule/displayName.md similarity index 100% rename from services/validation/v1/operations/delete-validation-propertyvalue-rule/displayName.md rename to apis/validation/v1/operations/delete-validation-propertyvalue-rule/displayName.md diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-run/description.md b/apis/validation/v1/operations/delete-validation-propertyvalue-run/description.md similarity index 100% rename from services/validation/v1/operations/delete-validation-propertyvalue-run/description.md rename to apis/validation/v1/operations/delete-validation-propertyvalue-run/description.md diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-run/displayName.md b/apis/validation/v1/operations/delete-validation-propertyvalue-run/displayName.md similarity index 100% rename from services/validation/v1/operations/delete-validation-propertyvalue-run/displayName.md rename to apis/validation/v1/operations/delete-validation-propertyvalue-run/displayName.md diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-test/description.md b/apis/validation/v1/operations/delete-validation-propertyvalue-test/description.md similarity index 100% rename from services/validation/v1/operations/delete-validation-propertyvalue-test/description.md rename to apis/validation/v1/operations/delete-validation-propertyvalue-test/description.md diff --git a/services/validation/v1/operations/delete-validation-propertyvalue-test/displayName.md b/apis/validation/v1/operations/delete-validation-propertyvalue-test/displayName.md similarity index 100% rename from services/validation/v1/operations/delete-validation-propertyvalue-test/displayName.md rename to apis/validation/v1/operations/delete-validation-propertyvalue-test/displayName.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-properties/description.md b/apis/validation/v1/operations/get-validation-propertyvalue-properties/description.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-properties/description.md rename to apis/validation/v1/operations/get-validation-propertyvalue-properties/description.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-properties/displayName.md b/apis/validation/v1/operations/get-validation-propertyvalue-properties/displayName.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-properties/displayName.md rename to apis/validation/v1/operations/get-validation-propertyvalue-properties/displayName.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-result/description.md b/apis/validation/v1/operations/get-validation-propertyvalue-result/description.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-result/description.md rename to apis/validation/v1/operations/get-validation-propertyvalue-result/description.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-result/displayName.md b/apis/validation/v1/operations/get-validation-propertyvalue-result/displayName.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-result/displayName.md rename to apis/validation/v1/operations/get-validation-propertyvalue-result/displayName.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rule-templates/description.md b/apis/validation/v1/operations/get-validation-propertyvalue-rule-templates/description.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-rule-templates/description.md rename to apis/validation/v1/operations/get-validation-propertyvalue-rule-templates/description.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rule-templates/displayName.md b/apis/validation/v1/operations/get-validation-propertyvalue-rule-templates/displayName.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-rule-templates/displayName.md rename to apis/validation/v1/operations/get-validation-propertyvalue-rule-templates/displayName.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rule/description.md b/apis/validation/v1/operations/get-validation-propertyvalue-rule/description.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-rule/description.md rename to apis/validation/v1/operations/get-validation-propertyvalue-rule/description.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rule/displayName.md b/apis/validation/v1/operations/get-validation-propertyvalue-rule/displayName.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-rule/displayName.md rename to apis/validation/v1/operations/get-validation-propertyvalue-rule/displayName.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rules/description.md b/apis/validation/v1/operations/get-validation-propertyvalue-rules/description.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-rules/description.md rename to apis/validation/v1/operations/get-validation-propertyvalue-rules/description.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-rules/displayName.md b/apis/validation/v1/operations/get-validation-propertyvalue-rules/displayName.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-rules/displayName.md rename to apis/validation/v1/operations/get-validation-propertyvalue-rules/displayName.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-run/description.md b/apis/validation/v1/operations/get-validation-propertyvalue-run/description.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-run/description.md rename to apis/validation/v1/operations/get-validation-propertyvalue-run/description.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-run/displayName.md b/apis/validation/v1/operations/get-validation-propertyvalue-run/displayName.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-run/displayName.md rename to apis/validation/v1/operations/get-validation-propertyvalue-run/displayName.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-runs/description.md b/apis/validation/v1/operations/get-validation-propertyvalue-runs/description.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-runs/description.md rename to apis/validation/v1/operations/get-validation-propertyvalue-runs/description.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-runs/displayName.md b/apis/validation/v1/operations/get-validation-propertyvalue-runs/displayName.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-runs/displayName.md rename to apis/validation/v1/operations/get-validation-propertyvalue-runs/displayName.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-test/description.md b/apis/validation/v1/operations/get-validation-propertyvalue-test/description.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-test/description.md rename to apis/validation/v1/operations/get-validation-propertyvalue-test/description.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-test/displayName.md b/apis/validation/v1/operations/get-validation-propertyvalue-test/displayName.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-test/displayName.md rename to apis/validation/v1/operations/get-validation-propertyvalue-test/displayName.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-tests/description.md b/apis/validation/v1/operations/get-validation-propertyvalue-tests/description.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-tests/description.md rename to apis/validation/v1/operations/get-validation-propertyvalue-tests/description.md diff --git a/services/validation/v1/operations/get-validation-propertyvalue-tests/displayName.md b/apis/validation/v1/operations/get-validation-propertyvalue-tests/displayName.md similarity index 100% rename from services/validation/v1/operations/get-validation-propertyvalue-tests/displayName.md rename to apis/validation/v1/operations/get-validation-propertyvalue-tests/displayName.md diff --git a/services/validation/v1/operations/run-validation-propertyvalue-test/description.md b/apis/validation/v1/operations/run-validation-propertyvalue-test/description.md similarity index 100% rename from services/validation/v1/operations/run-validation-propertyvalue-test/description.md rename to apis/validation/v1/operations/run-validation-propertyvalue-test/description.md diff --git a/services/validation/v1/operations/run-validation-propertyvalue-test/displayName.md b/apis/validation/v1/operations/run-validation-propertyvalue-test/displayName.md similarity index 100% rename from services/validation/v1/operations/run-validation-propertyvalue-test/displayName.md rename to apis/validation/v1/operations/run-validation-propertyvalue-test/displayName.md diff --git a/services/validation/v1/operations/update-validation-propertyvalue-rule/description.md b/apis/validation/v1/operations/update-validation-propertyvalue-rule/description.md similarity index 100% rename from services/validation/v1/operations/update-validation-propertyvalue-rule/description.md rename to apis/validation/v1/operations/update-validation-propertyvalue-rule/description.md diff --git a/services/validation/v1/operations/update-validation-propertyvalue-rule/displayName.md b/apis/validation/v1/operations/update-validation-propertyvalue-rule/displayName.md similarity index 100% rename from services/validation/v1/operations/update-validation-propertyvalue-rule/displayName.md rename to apis/validation/v1/operations/update-validation-propertyvalue-rule/displayName.md diff --git a/services/validation/v1/operations/update-validation-propertyvalue-test/description.md b/apis/validation/v1/operations/update-validation-propertyvalue-test/description.md similarity index 100% rename from services/validation/v1/operations/update-validation-propertyvalue-test/description.md rename to apis/validation/v1/operations/update-validation-propertyvalue-test/description.md diff --git a/services/validation/v1/operations/update-validation-propertyvalue-test/displayName.md b/apis/validation/v1/operations/update-validation-propertyvalue-test/displayName.md similarity index 100% rename from services/validation/v1/operations/update-validation-propertyvalue-test/displayName.md rename to apis/validation/v1/operations/update-validation-propertyvalue-test/displayName.md diff --git a/services/webhooks/v2/description.md b/apis/webhooks/v2/description.md similarity index 100% rename from services/webhooks/v2/description.md rename to apis/webhooks/v2/description.md diff --git a/services/webhooks/v2/operations/create-webhook/description.md b/apis/webhooks/v2/operations/create-webhook/description.md similarity index 100% rename from services/webhooks/v2/operations/create-webhook/description.md rename to apis/webhooks/v2/operations/create-webhook/description.md diff --git a/services/webhooks/v2/operations/create-webhook/displayName.md b/apis/webhooks/v2/operations/create-webhook/displayName.md similarity index 100% rename from services/webhooks/v2/operations/create-webhook/displayName.md rename to apis/webhooks/v2/operations/create-webhook/displayName.md diff --git a/services/webhooks/v2/operations/delete-webhook/description.md b/apis/webhooks/v2/operations/delete-webhook/description.md similarity index 100% rename from services/webhooks/v2/operations/delete-webhook/description.md rename to apis/webhooks/v2/operations/delete-webhook/description.md diff --git a/services/webhooks/v2/operations/delete-webhook/displayName.md b/apis/webhooks/v2/operations/delete-webhook/displayName.md similarity index 100% rename from services/webhooks/v2/operations/delete-webhook/displayName.md rename to apis/webhooks/v2/operations/delete-webhook/displayName.md diff --git a/services/webhooks/v2/operations/get-webhook/description.md b/apis/webhooks/v2/operations/get-webhook/description.md similarity index 100% rename from services/webhooks/v2/operations/get-webhook/description.md rename to apis/webhooks/v2/operations/get-webhook/description.md diff --git a/services/webhooks/v2/operations/get-webhook/displayName.md b/apis/webhooks/v2/operations/get-webhook/displayName.md similarity index 100% rename from services/webhooks/v2/operations/get-webhook/displayName.md rename to apis/webhooks/v2/operations/get-webhook/displayName.md diff --git a/services/webhooks/v2/operations/get-webhooks/description.md b/apis/webhooks/v2/operations/get-webhooks/description.md similarity index 100% rename from services/webhooks/v2/operations/get-webhooks/description.md rename to apis/webhooks/v2/operations/get-webhooks/description.md diff --git a/services/webhooks/v2/operations/get-webhooks/displayName.md b/apis/webhooks/v2/operations/get-webhooks/displayName.md similarity index 100% rename from services/webhooks/v2/operations/get-webhooks/displayName.md rename to apis/webhooks/v2/operations/get-webhooks/displayName.md diff --git a/services/webhooks/v2/operations/update-webhook/description.md b/apis/webhooks/v2/operations/update-webhook/description.md similarity index 100% rename from services/webhooks/v2/operations/update-webhook/description.md rename to apis/webhooks/v2/operations/update-webhook/description.md diff --git a/services/webhooks/v2/operations/update-webhook/displayName.md b/apis/webhooks/v2/operations/update-webhook/displayName.md similarity index 100% rename from services/webhooks/v2/operations/update-webhook/displayName.md rename to apis/webhooks/v2/operations/update-webhook/displayName.md diff --git a/apis/operations/description/Authorization.md b/common/operations/description/Authorization.md similarity index 100% rename from apis/operations/description/Authorization.md rename to common/operations/description/Authorization.md diff --git a/apis/operations/description/OrganizationAdministrator.md b/common/operations/description/OrganizationAdministrator.md similarity index 100% rename from apis/operations/description/OrganizationAdministrator.md rename to common/operations/description/OrganizationAdministrator.md diff --git a/apis/operations/description/ProjectsDeprecated.md b/common/operations/description/ProjectsDeprecated.md similarity index 100% rename from apis/operations/description/ProjectsDeprecated.md rename to common/operations/description/ProjectsDeprecated.md diff --git a/apis/operations/description/RateLimits.md b/common/operations/description/RateLimits.md similarity index 100% rename from apis/operations/description/RateLimits.md rename to common/operations/description/RateLimits.md diff --git a/apis/operations/description/RbacPermissions.md b/common/operations/description/RbacPermissions.md similarity index 100% rename from apis/operations/description/RbacPermissions.md rename to common/operations/description/RbacPermissions.md diff --git a/apis/operations/description/iTwinsRBACPermission.md b/common/operations/description/iTwinsRBACPermission.md similarity index 100% rename from apis/operations/description/iTwinsRBACPermission.md rename to common/operations/description/iTwinsRBACPermission.md From 775918d6632aeb10db96bccb8c22205ecd6474d2 Mon Sep 17 00:00:00 2001 From: Linas B Date: Wed, 4 Sep 2024 22:23:08 +0300 Subject: [PATCH 3/5] Added title and apiName files --- apis/access-control/v2/apiName.md | 1 + apis/access-control/v2/description.md | 6 +----- .../add-itwin-group-members/description.md | 12 ++---------- .../operations/add-itwin-owner-member/description.md | 12 ++---------- .../operations/add-itwin-user-members/description.md | 12 ++---------- .../v2/operations/create-iTwin-role/description.md | 12 ++---------- .../v2/operations/create-itwin-group/description.md | 6 +----- .../v2/operations/create-itwin-job/description.md | 12 ++---------- .../v2/operations/delete-iTwin-role/description.md | 12 ++---------- .../v2/operations/delete-itwin-group/description.md | 6 +----- .../v2/operations/get-all-permissions/description.md | 6 +----- .../operations/get-iTwin-permissions/description.md | 6 +----- .../v2/operations/get-iTwin-roles/description.md | 12 ++---------- .../operations/get-itwin-group-member/description.md | 8 ++------ .../get-itwin-group-members/description.md | 8 ++------ .../v2/operations/get-itwin-group/description.md | 6 +----- .../v2/operations/get-itwin-groups/description.md | 6 +----- .../operations/get-itwin-job-actions/description.md | 12 ++---------- .../v2/operations/get-itwin-job/description.md | 12 ++---------- .../get-itwin-member-invitations/description.md | 2 +- .../get-itwin-owner-members/description.md | 8 ++------ .../v2/operations/get-itwin-role/description.md | 12 ++---------- .../operations/get-itwin-user-member/description.md | 8 ++------ .../operations/get-itwin-user-members/description.md | 8 ++------ .../remove-itwin-group-member/description.md | 12 ++---------- .../remove-itwin-owner-member/description.md | 12 ++---------- .../remove-itwin-user-member/description.md | 12 ++---------- .../v2/operations/update-iTwin-role/description.md | 12 ++---------- .../update-itwin-group-member/description.md | 12 ++---------- .../v2/operations/update-itwin-group/description.md | 6 +----- .../update-itwin-user-member/description.md | 12 ++---------- apis/access-control/v2/title.md | 1 + apis/carbon-calculation/v1/apiName.md | 1 + apis/carbon-calculation/v1/title.md | 1 + apis/changed-elements/v2/apiName.md | 1 + apis/changed-elements/v2/title.md | 1 + apis/clash-detection/v2/apiName.md | 1 + apis/clash-detection/v2/title.md | 1 + apis/contextcapture/v1/apiName.md | 1 + apis/contextcapture/v1/title.md | 1 + apis/echo/v2/apiName.md | 1 + apis/echo/v2/title.md | 1 + apis/export/v1/apiName.md | 1 + apis/export/v1/title.md | 1 + apis/extensions/v1/apiName.md | 1 + apis/extensions/v1/title.md | 1 + apis/forms/v1/apiName.md | 1 + apis/forms/v1/title.md | 1 + apis/grouping-and-mapping/v1/apiName.md | 1 + apis/grouping-and-mapping/v1/title.md | 1 + apis/imodel-rpc/v1/apiName.md | 1 + apis/imodel-rpc/v1/title.md | 1 + apis/imodels-odata/v1/apiName.md | 1 + apis/imodels-odata/v1/title.md | 1 + apis/imodels/v2/apiName.md | 1 + apis/imodels/v2/title.md | 1 + apis/issues/v1/apiName.md | 1 + apis/issues/v1/title.md | 1 + apis/itwin-entities/v1/apiName.md | 1 + apis/itwin-entities/v1/title.md | 1 + apis/itwin-search/v1/apiName.md | 1 + apis/itwin-search/v1/title.md | 1 + apis/itwins/v1/apiName.md | 1 + apis/itwins/v1/title.md | 1 + apis/library/v1/apiName.md | 1 + apis/library/v1/title.md | 1 + apis/mesh-export/v1/apiName.md | 1 + apis/mesh-export/v1/title.md | 1 + apis/named-groups/v1/apiName.md | 1 + apis/named-groups/v1/title.md | 1 + apis/pnid-to-itwin/v2/apiName.md | 1 + apis/pnid-to-itwin/v2/title.md | 1 + apis/projects/v1/apiName.md | 1 + apis/projects/v1/title.md | 1 + apis/projectwise365-insights/v1/apiName.md | 1 + apis/projectwise365-insights/v1/title.md | 1 + apis/reality-data/v1/apiName.md | 1 + apis/reality-data/v1/title.md | 1 + apis/reality-management/v1/apiName.md | 1 + apis/reality-management/v1/title.md | 1 + apis/realityconversion/v1/apiName.md | 1 + apis/realityconversion/v1/title.md | 1 + apis/realitydataanalysis/v1/apiName.md | 1 + apis/realitydataanalysis/v1/title.md | 1 + apis/reporting/v2/apiName.md | 1 + apis/reporting/v2/title.md | 1 + apis/savedviews/v1/apiName.md | 1 + apis/savedviews/v1/title.md | 1 + apis/sensor-data-websocket/v1/apiName.md | 1 + apis/sensor-data-websocket/v1/title.md | 1 + apis/sensor-data/v1/apiName.md | 1 + apis/sensor-data/v1/title.md | 1 + apis/storage-container/v1/apiName.md | 1 + apis/storage-container/v1/title.md | 1 + apis/storage/v1/apiName.md | 1 + apis/storage/v1/title.md | 1 + apis/synchronization/v1/apiName.md | 1 + apis/synchronization/v1/title.md | 1 + apis/transformations/v1/apiName.md | 1 + apis/transformations/v1/title.md | 1 + apis/users/v1/apiName.md | 1 + apis/users/v1/title.md | 1 + apis/validation/v1/apiName.md | 1 + apis/validation/v1/title.md | 1 + apis/webhooks/v2/apiName.md | 1 + apis/webhooks/v2/title.md | 1 + 106 files changed, 127 insertions(+), 231 deletions(-) create mode 100644 apis/access-control/v2/apiName.md create mode 100644 apis/access-control/v2/title.md create mode 100644 apis/carbon-calculation/v1/apiName.md create mode 100644 apis/carbon-calculation/v1/title.md create mode 100644 apis/changed-elements/v2/apiName.md create mode 100644 apis/changed-elements/v2/title.md create mode 100644 apis/clash-detection/v2/apiName.md create mode 100644 apis/clash-detection/v2/title.md create mode 100644 apis/contextcapture/v1/apiName.md create mode 100644 apis/contextcapture/v1/title.md create mode 100644 apis/echo/v2/apiName.md create mode 100644 apis/echo/v2/title.md create mode 100644 apis/export/v1/apiName.md create mode 100644 apis/export/v1/title.md create mode 100644 apis/extensions/v1/apiName.md create mode 100644 apis/extensions/v1/title.md create mode 100644 apis/forms/v1/apiName.md create mode 100644 apis/forms/v1/title.md create mode 100644 apis/grouping-and-mapping/v1/apiName.md create mode 100644 apis/grouping-and-mapping/v1/title.md create mode 100644 apis/imodel-rpc/v1/apiName.md create mode 100644 apis/imodel-rpc/v1/title.md create mode 100644 apis/imodels-odata/v1/apiName.md create mode 100644 apis/imodels-odata/v1/title.md create mode 100644 apis/imodels/v2/apiName.md create mode 100644 apis/imodels/v2/title.md create mode 100644 apis/issues/v1/apiName.md create mode 100644 apis/issues/v1/title.md create mode 100644 apis/itwin-entities/v1/apiName.md create mode 100644 apis/itwin-entities/v1/title.md create mode 100644 apis/itwin-search/v1/apiName.md create mode 100644 apis/itwin-search/v1/title.md create mode 100644 apis/itwins/v1/apiName.md create mode 100644 apis/itwins/v1/title.md create mode 100644 apis/library/v1/apiName.md create mode 100644 apis/library/v1/title.md create mode 100644 apis/mesh-export/v1/apiName.md create mode 100644 apis/mesh-export/v1/title.md create mode 100644 apis/named-groups/v1/apiName.md create mode 100644 apis/named-groups/v1/title.md create mode 100644 apis/pnid-to-itwin/v2/apiName.md create mode 100644 apis/pnid-to-itwin/v2/title.md create mode 100644 apis/projects/v1/apiName.md create mode 100644 apis/projects/v1/title.md create mode 100644 apis/projectwise365-insights/v1/apiName.md create mode 100644 apis/projectwise365-insights/v1/title.md create mode 100644 apis/reality-data/v1/apiName.md create mode 100644 apis/reality-data/v1/title.md create mode 100644 apis/reality-management/v1/apiName.md create mode 100644 apis/reality-management/v1/title.md create mode 100644 apis/realityconversion/v1/apiName.md create mode 100644 apis/realityconversion/v1/title.md create mode 100644 apis/realitydataanalysis/v1/apiName.md create mode 100644 apis/realitydataanalysis/v1/title.md create mode 100644 apis/reporting/v2/apiName.md create mode 100644 apis/reporting/v2/title.md create mode 100644 apis/savedviews/v1/apiName.md create mode 100644 apis/savedviews/v1/title.md create mode 100644 apis/sensor-data-websocket/v1/apiName.md create mode 100644 apis/sensor-data-websocket/v1/title.md create mode 100644 apis/sensor-data/v1/apiName.md create mode 100644 apis/sensor-data/v1/title.md create mode 100644 apis/storage-container/v1/apiName.md create mode 100644 apis/storage-container/v1/title.md create mode 100644 apis/storage/v1/apiName.md create mode 100644 apis/storage/v1/title.md create mode 100644 apis/synchronization/v1/apiName.md create mode 100644 apis/synchronization/v1/title.md create mode 100644 apis/transformations/v1/apiName.md create mode 100644 apis/transformations/v1/title.md create mode 100644 apis/users/v1/apiName.md create mode 100644 apis/users/v1/title.md create mode 100644 apis/validation/v1/apiName.md create mode 100644 apis/validation/v1/title.md create mode 100644 apis/webhooks/v2/apiName.md create mode 100644 apis/webhooks/v2/title.md diff --git a/apis/access-control/v2/apiName.md b/apis/access-control/v2/apiName.md new file mode 100644 index 0000000..fd50196 --- /dev/null +++ b/apis/access-control/v2/apiName.md @@ -0,0 +1 @@ +access-control-v2 diff --git a/apis/access-control/v2/description.md b/apis/access-control/v2/description.md index 7baf7e1..667782e 100644 --- a/apis/access-control/v2/description.md +++ b/apis/access-control/v2/description.md @@ -1,5 +1 @@ ---- - -Manage Access Controls for your iTwin member using iTwin roles and permissions. - ---- \ No newline at end of file +Manage Access Controls for your iTwin member using iTwin roles and permissions. \ No newline at end of file diff --git a/apis/access-control/v2/operations/add-itwin-group-members/description.md b/apis/access-control/v2/operations/add-itwin-group-members/description.md index b521de9..b012ef9 100644 --- a/apis/access-control/v2/operations/add-itwin-group-members/description.md +++ b/apis/access-control/v2/operations/add-itwin-group-members/description.md @@ -4,16 +4,8 @@ Add new iTwin group members The total number of roles assigned in this request must not exceed 50. This can be achieved with many different configurations. For example, 1 role can be assigned to 50 groups, or 5 roles can be assigned to 10 groups, both resulting in 50 role assignments. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `administration_invite_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/add-itwin-owner-member/description.md b/apis/access-control/v2/operations/add-itwin-owner-member/description.md index 939b763..934fc92 100644 --- a/apis/access-control/v2/operations/add-itwin-owner-member/description.md +++ b/apis/access-control/v2/operations/add-itwin-owner-member/description.md @@ -6,18 +6,10 @@ Users which are external (i.e. not in the same organization as the iTwin) are no Invited individuals will recieve an invitation via Email, where they'll be prompted to accept the invitation. Upon accepting, they'll then become a member of the iTwin. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} You must be an owner to add other owners. -### Authorization - -User must have the `administration_invite_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/add-itwin-user-members/description.md b/apis/access-control/v2/operations/add-itwin-user-members/description.md index 2c218d9..2fa089c 100644 --- a/apis/access-control/v2/operations/add-itwin-user-members/description.md +++ b/apis/access-control/v2/operations/add-itwin-user-members/description.md @@ -6,16 +6,8 @@ Invited individuals will recieve an invitation via Email, where they'll be promp The total number of roles assigned in this request must not exceed 50. This can be achieved with many different configurations. For example, 1 role can be assigned to 50 users, or 5 roles can be assigned to 10 users, both resulting in 50 role assignments. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `administration_invite_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/create-iTwin-role/description.md b/apis/access-control/v2/operations/create-iTwin-role/description.md index 62c143d..721da6d 100644 --- a/apis/access-control/v2/operations/create-iTwin-role/description.md +++ b/apis/access-control/v2/operations/create-iTwin-role/description.md @@ -2,16 +2,8 @@ Create a new iTwin role. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `administration_manage_roles` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/create-itwin-group/description.md b/apis/access-control/v2/operations/create-itwin-group/description.md index a2cf196..f0696c0 100644 --- a/apis/access-control/v2/operations/create-itwin-group/description.md +++ b/apis/access-control/v2/operations/create-itwin-group/description.md @@ -2,11 +2,7 @@ Create a new iTwin group. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization diff --git a/apis/access-control/v2/operations/create-itwin-job/description.md b/apis/access-control/v2/operations/create-itwin-job/description.md index d101c17..fbd6cb7 100644 --- a/apis/access-control/v2/operations/create-itwin-job/description.md +++ b/apis/access-control/v2/operations/create-itwin-job/description.md @@ -12,16 +12,8 @@ Note: If the user being assigned roles in the `assignRoles` action is not a memb `assignRoles` and `unassignRoles` actions have a limit of 100 roles per group of actions. `removeMembers` has a limit of 100 emails. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `{permission}` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/delete-iTwin-role/description.md b/apis/access-control/v2/operations/delete-iTwin-role/description.md index b35426d..92734fe 100644 --- a/apis/access-control/v2/operations/delete-iTwin-role/description.md +++ b/apis/access-control/v2/operations/delete-iTwin-role/description.md @@ -2,16 +2,8 @@ Delete the specified iTwin role. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `administration_manage_roles` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/delete-itwin-group/description.md b/apis/access-control/v2/operations/delete-itwin-group/description.md index ae86084..f0e28b7 100644 --- a/apis/access-control/v2/operations/delete-itwin-group/description.md +++ b/apis/access-control/v2/operations/delete-itwin-group/description.md @@ -2,11 +2,7 @@ Delete the specified iTwin group. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization diff --git a/apis/access-control/v2/operations/get-all-permissions/description.md b/apis/access-control/v2/operations/get-all-permissions/description.md index 751f14a..2f8242f 100644 --- a/apis/access-control/v2/operations/get-all-permissions/description.md +++ b/apis/access-control/v2/operations/get-all-permissions/description.md @@ -2,11 +2,7 @@ Retrieves the list of all available permissions -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization diff --git a/apis/access-control/v2/operations/get-iTwin-permissions/description.md b/apis/access-control/v2/operations/get-iTwin-permissions/description.md index 940454b..5f31273 100644 --- a/apis/access-control/v2/operations/get-iTwin-permissions/description.md +++ b/apis/access-control/v2/operations/get-iTwin-permissions/description.md @@ -2,11 +2,7 @@ Retrieves a list of permissions the calling user has on a specified iTwin. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization diff --git a/apis/access-control/v2/operations/get-iTwin-roles/description.md b/apis/access-control/v2/operations/get-iTwin-roles/description.md index eae28b4..1bb922d 100644 --- a/apis/access-control/v2/operations/get-iTwin-roles/description.md +++ b/apis/access-control/v2/operations/get-iTwin-roles/description.md @@ -2,16 +2,8 @@ Retrieves a list of available user roles that are defined for a specified iTwin. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `administration_manage_roles` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/get-itwin-group-member/description.md b/apis/access-control/v2/operations/get-itwin-group-member/description.md index 1d3994d..6423da3 100644 --- a/apis/access-control/v2/operations/get-itwin-group-member/description.md +++ b/apis/access-control/v2/operations/get-itwin-group-member/description.md @@ -2,16 +2,12 @@ Retrieves a specific group member for a specified iTwin. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization The calling user must be a member of the iTwin. Organization Administrator can also retrieve an iTwin member for any iTwin in their Organization. -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!OrganizationAdministrator.md!} --- diff --git a/apis/access-control/v2/operations/get-itwin-group-members/description.md b/apis/access-control/v2/operations/get-itwin-group-members/description.md index b88d78c..438c5f6 100644 --- a/apis/access-control/v2/operations/get-itwin-group-members/description.md +++ b/apis/access-control/v2/operations/get-itwin-group-members/description.md @@ -2,16 +2,12 @@ Retrieves a list of iTwin group members and their roles assignments. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin members for any iTwin in their Organization. -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!OrganizationAdministrator.md!} --- diff --git a/apis/access-control/v2/operations/get-itwin-group/description.md b/apis/access-control/v2/operations/get-itwin-group/description.md index 01a36b7..2f8f763 100644 --- a/apis/access-control/v2/operations/get-itwin-group/description.md +++ b/apis/access-control/v2/operations/get-itwin-group/description.md @@ -2,11 +2,7 @@ Retrieves the specified group for the specified iTwin. The `members` and `imsGroups` properties are both capped at 50 each. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization diff --git a/apis/access-control/v2/operations/get-itwin-groups/description.md b/apis/access-control/v2/operations/get-itwin-groups/description.md index 7088c5e..479afeb 100644 --- a/apis/access-control/v2/operations/get-itwin-groups/description.md +++ b/apis/access-control/v2/operations/get-itwin-groups/description.md @@ -2,11 +2,7 @@ Retrieves a list of all groups that are defined for a specified iTwin. The `members` and `imsGroups` properties are both capped at 50 each. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization diff --git a/apis/access-control/v2/operations/get-itwin-job-actions/description.md b/apis/access-control/v2/operations/get-itwin-job-actions/description.md index 7a47fde..6660bc9 100644 --- a/apis/access-control/v2/operations/get-itwin-job-actions/description.md +++ b/apis/access-control/v2/operations/get-itwin-job-actions/description.md @@ -2,16 +2,8 @@ Retrieves the iTwin job actions for the specified iTwin job for the specified iTwin. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `{permission}` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/get-itwin-job/description.md b/apis/access-control/v2/operations/get-itwin-job/description.md index bc9634b..8b58d44 100644 --- a/apis/access-control/v2/operations/get-itwin-job/description.md +++ b/apis/access-control/v2/operations/get-itwin-job/description.md @@ -11,16 +11,8 @@ By default this operation will only return the `status` of the iTwin job. To fin - `PartialCompleted`: iTwin job completed with some actions failing. To find the specific errors of the iTwin job, include `return=representation` in the `Prefer` header. - `Failed`: iTwin job completed with all actions failing. To find the specific errors of the iTwin job, include `return=representation` in the `Prefer` header. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `{permission}` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/get-itwin-member-invitations/description.md b/apis/access-control/v2/operations/get-itwin-member-invitations/description.md index 85148e2..579b70c 100644 --- a/apis/access-control/v2/operations/get-itwin-member-invitations/description.md +++ b/apis/access-control/v2/operations/get-itwin-member-invitations/description.md @@ -8,6 +8,6 @@ Invitations have an expiration of 7 days after their creation. Once that expirat The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin member invitations for any iTwin in their Organization. -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!OrganizationAdministrator.md!} --- diff --git a/apis/access-control/v2/operations/get-itwin-owner-members/description.md b/apis/access-control/v2/operations/get-itwin-owner-members/description.md index 4c29298..fa5bbf9 100644 --- a/apis/access-control/v2/operations/get-itwin-owner-members/description.md +++ b/apis/access-control/v2/operations/get-itwin-owner-members/description.md @@ -23,16 +23,12 @@ The Access Control API will perform a once-a-week cleanup to remove these "Missi If not, you can use the [Remove iTwin Owner Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-owner-member/) API (use the memberId) to remove the owner member from the iTwin. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin owner members for any iTwin in their Organization. -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!OrganizationAdministrator.md!} --- diff --git a/apis/access-control/v2/operations/get-itwin-role/description.md b/apis/access-control/v2/operations/get-itwin-role/description.md index 838e369..6ba0a3e 100644 --- a/apis/access-control/v2/operations/get-itwin-role/description.md +++ b/apis/access-control/v2/operations/get-itwin-role/description.md @@ -2,16 +2,8 @@ Retrieves the specified role for the specified iTwin. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `administration_manage_roles` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/get-itwin-user-member/description.md b/apis/access-control/v2/operations/get-itwin-user-member/description.md index a669cb6..25c722b 100644 --- a/apis/access-control/v2/operations/get-itwin-user-member/description.md +++ b/apis/access-control/v2/operations/get-itwin-user-member/description.md @@ -23,16 +23,12 @@ The Access Control API will perform a once-a-week cleanup to remove these "Missi If not, you can use the [Remove iTwin User Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-user-member/) API (use the memberId) to remove the user member from the iTwin. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization The calling user must be a member of the iTwin. Organization Administrator can also retrieve an iTwin user member for any iTwin in their Organization. -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!OrganizationAdministrator.md!} --- diff --git a/apis/access-control/v2/operations/get-itwin-user-members/description.md b/apis/access-control/v2/operations/get-itwin-user-members/description.md index 4e7001e..032493a 100644 --- a/apis/access-control/v2/operations/get-itwin-user-members/description.md +++ b/apis/access-control/v2/operations/get-itwin-user-members/description.md @@ -23,16 +23,12 @@ The Access Control API will perform a once-a-week cleanup to remove these "Missi If not, you can use the [Remove iTwin User Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-user-member/) API (use the memberId) to remove the user member from the iTwin. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin user members for any iTwin in their Organization. -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!OrganizationAdministrator.md!} --- diff --git a/apis/access-control/v2/operations/remove-itwin-group-member/description.md b/apis/access-control/v2/operations/remove-itwin-group-member/description.md index f0d236d..a0be90c 100644 --- a/apis/access-control/v2/operations/remove-itwin-group-member/description.md +++ b/apis/access-control/v2/operations/remove-itwin-group-member/description.md @@ -2,16 +2,8 @@ Remove the specified group member from the iTwin. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `administration_remove_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/remove-itwin-owner-member/description.md b/apis/access-control/v2/operations/remove-itwin-owner-member/description.md index 113c8c7..02810a6 100644 --- a/apis/access-control/v2/operations/remove-itwin-owner-member/description.md +++ b/apis/access-control/v2/operations/remove-itwin-owner-member/description.md @@ -2,18 +2,10 @@ Remove the specified owner from the iTwin. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} You must be an owner to remove other owners. -### Authorization - -User must have the `administration_remove_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/remove-itwin-user-member/description.md b/apis/access-control/v2/operations/remove-itwin-user-member/description.md index 86e534f..6009286 100644 --- a/apis/access-control/v2/operations/remove-itwin-user-member/description.md +++ b/apis/access-control/v2/operations/remove-itwin-user-member/description.md @@ -2,16 +2,8 @@ Remove the specified user member from the iTwin. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `administration_remove_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/update-iTwin-role/description.md b/apis/access-control/v2/operations/update-iTwin-role/description.md index a4f0e3f..d2b7b60 100644 --- a/apis/access-control/v2/operations/update-iTwin-role/description.md +++ b/apis/access-control/v2/operations/update-iTwin-role/description.md @@ -2,16 +2,8 @@ Update the specified iTwin role. -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `administration_manage_roles` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/update-itwin-group-member/description.md b/apis/access-control/v2/operations/update-itwin-group-member/description.md index a7a8f3a..3ec5c7f 100644 --- a/apis/access-control/v2/operations/update-itwin-group-member/description.md +++ b/apis/access-control/v2/operations/update-itwin-group-member/description.md @@ -2,16 +2,8 @@ Update an iTwin group member's role assignments -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `administration_invite_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/operations/update-itwin-group/description.md b/apis/access-control/v2/operations/update-itwin-group/description.md index 3eccaa1..d021b08 100644 --- a/apis/access-control/v2/operations/update-itwin-group/description.md +++ b/apis/access-control/v2/operations/update-itwin-group/description.md @@ -2,11 +2,7 @@ Update the specified iTwin group. The `members` and `imsGroups` properties are both capped at 50 each. -### Authentication - -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. +{!Authorization.md!} ### Authorization diff --git a/apis/access-control/v2/operations/update-itwin-user-member/description.md b/apis/access-control/v2/operations/update-itwin-user-member/description.md index 420e618..e7e6f8e 100644 --- a/apis/access-control/v2/operations/update-itwin-user-member/description.md +++ b/apis/access-control/v2/operations/update-itwin-user-member/description.md @@ -2,16 +2,8 @@ Update an iTwin user member's role assignments -### Authentication +{!Authorization.md!} -Requires `Authorization` header with valid Bearer token for scope `itwin-platform`. - -For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page. - -### Authorization - -User must have the `administration_invite_member` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page. +{!iTwinsRBACPermission.md!} --- diff --git a/apis/access-control/v2/title.md b/apis/access-control/v2/title.md new file mode 100644 index 0000000..d9cfe0b --- /dev/null +++ b/apis/access-control/v2/title.md @@ -0,0 +1 @@ +Access Control diff --git a/apis/carbon-calculation/v1/apiName.md b/apis/carbon-calculation/v1/apiName.md new file mode 100644 index 0000000..0092bd5 --- /dev/null +++ b/apis/carbon-calculation/v1/apiName.md @@ -0,0 +1 @@ +carbon-calculation diff --git a/apis/carbon-calculation/v1/title.md b/apis/carbon-calculation/v1/title.md new file mode 100644 index 0000000..d98aa84 --- /dev/null +++ b/apis/carbon-calculation/v1/title.md @@ -0,0 +1 @@ +Carbon Calculation diff --git a/apis/changed-elements/v2/apiName.md b/apis/changed-elements/v2/apiName.md new file mode 100644 index 0000000..ee59ebf --- /dev/null +++ b/apis/changed-elements/v2/apiName.md @@ -0,0 +1 @@ +changed-elements-v2 diff --git a/apis/changed-elements/v2/title.md b/apis/changed-elements/v2/title.md new file mode 100644 index 0000000..7bb55c5 --- /dev/null +++ b/apis/changed-elements/v2/title.md @@ -0,0 +1 @@ +Changed Elements diff --git a/apis/clash-detection/v2/apiName.md b/apis/clash-detection/v2/apiName.md new file mode 100644 index 0000000..02b4f32 --- /dev/null +++ b/apis/clash-detection/v2/apiName.md @@ -0,0 +1 @@ +clash-detection-v2 diff --git a/apis/clash-detection/v2/title.md b/apis/clash-detection/v2/title.md new file mode 100644 index 0000000..0bb857b --- /dev/null +++ b/apis/clash-detection/v2/title.md @@ -0,0 +1 @@ +Clash Detection diff --git a/apis/contextcapture/v1/apiName.md b/apis/contextcapture/v1/apiName.md new file mode 100644 index 0000000..88b620e --- /dev/null +++ b/apis/contextcapture/v1/apiName.md @@ -0,0 +1 @@ +contextcapture diff --git a/apis/contextcapture/v1/title.md b/apis/contextcapture/v1/title.md new file mode 100644 index 0000000..30d2ae7 --- /dev/null +++ b/apis/contextcapture/v1/title.md @@ -0,0 +1 @@ +Reality Modeling diff --git a/apis/echo/v2/apiName.md b/apis/echo/v2/apiName.md new file mode 100644 index 0000000..ae241a8 --- /dev/null +++ b/apis/echo/v2/apiName.md @@ -0,0 +1 @@ +echo-v2 diff --git a/apis/echo/v2/title.md b/apis/echo/v2/title.md new file mode 100644 index 0000000..3236536 --- /dev/null +++ b/apis/echo/v2/title.md @@ -0,0 +1 @@ +Echo Context API diff --git a/apis/export/v1/apiName.md b/apis/export/v1/apiName.md new file mode 100644 index 0000000..d563759 --- /dev/null +++ b/apis/export/v1/apiName.md @@ -0,0 +1 @@ +export diff --git a/apis/export/v1/title.md b/apis/export/v1/title.md new file mode 100644 index 0000000..ceef4a5 --- /dev/null +++ b/apis/export/v1/title.md @@ -0,0 +1 @@ +Export diff --git a/apis/extensions/v1/apiName.md b/apis/extensions/v1/apiName.md new file mode 100644 index 0000000..f427429 --- /dev/null +++ b/apis/extensions/v1/apiName.md @@ -0,0 +1 @@ +extensions diff --git a/apis/extensions/v1/title.md b/apis/extensions/v1/title.md new file mode 100644 index 0000000..3c505fe --- /dev/null +++ b/apis/extensions/v1/title.md @@ -0,0 +1 @@ +iTwin.js Extensions diff --git a/apis/forms/v1/apiName.md b/apis/forms/v1/apiName.md new file mode 100644 index 0000000..b002f20 --- /dev/null +++ b/apis/forms/v1/apiName.md @@ -0,0 +1 @@ +forms diff --git a/apis/forms/v1/title.md b/apis/forms/v1/title.md new file mode 100644 index 0000000..b5ba36f --- /dev/null +++ b/apis/forms/v1/title.md @@ -0,0 +1 @@ +Forms diff --git a/apis/grouping-and-mapping/v1/apiName.md b/apis/grouping-and-mapping/v1/apiName.md new file mode 100644 index 0000000..4612f67 --- /dev/null +++ b/apis/grouping-and-mapping/v1/apiName.md @@ -0,0 +1 @@ +grouping-and-mapping diff --git a/apis/grouping-and-mapping/v1/title.md b/apis/grouping-and-mapping/v1/title.md new file mode 100644 index 0000000..b788897 --- /dev/null +++ b/apis/grouping-and-mapping/v1/title.md @@ -0,0 +1 @@ +Grouping and Mapping diff --git a/apis/imodel-rpc/v1/apiName.md b/apis/imodel-rpc/v1/apiName.md new file mode 100644 index 0000000..1ed47b9 --- /dev/null +++ b/apis/imodel-rpc/v1/apiName.md @@ -0,0 +1 @@ +imodel-rpc diff --git a/apis/imodel-rpc/v1/title.md b/apis/imodel-rpc/v1/title.md new file mode 100644 index 0000000..133638a --- /dev/null +++ b/apis/imodel-rpc/v1/title.md @@ -0,0 +1 @@ +iModel RPC diff --git a/apis/imodels-odata/v1/apiName.md b/apis/imodels-odata/v1/apiName.md new file mode 100644 index 0000000..4edb4cc --- /dev/null +++ b/apis/imodels-odata/v1/apiName.md @@ -0,0 +1 @@ +imodels-odata diff --git a/apis/imodels-odata/v1/title.md b/apis/imodels-odata/v1/title.md new file mode 100644 index 0000000..4de2337 --- /dev/null +++ b/apis/imodels-odata/v1/title.md @@ -0,0 +1 @@ +iModels OData diff --git a/apis/imodels/v2/apiName.md b/apis/imodels/v2/apiName.md new file mode 100644 index 0000000..ea0e7f8 --- /dev/null +++ b/apis/imodels/v2/apiName.md @@ -0,0 +1 @@ +imodels-v2 diff --git a/apis/imodels/v2/title.md b/apis/imodels/v2/title.md new file mode 100644 index 0000000..1d0c668 --- /dev/null +++ b/apis/imodels/v2/title.md @@ -0,0 +1 @@ +iModels diff --git a/apis/issues/v1/apiName.md b/apis/issues/v1/apiName.md new file mode 100644 index 0000000..d0fe088 --- /dev/null +++ b/apis/issues/v1/apiName.md @@ -0,0 +1 @@ +issues-v1 diff --git a/apis/issues/v1/title.md b/apis/issues/v1/title.md new file mode 100644 index 0000000..f99478d --- /dev/null +++ b/apis/issues/v1/title.md @@ -0,0 +1 @@ +Issues diff --git a/apis/itwin-entities/v1/apiName.md b/apis/itwin-entities/v1/apiName.md new file mode 100644 index 0000000..8d440dc --- /dev/null +++ b/apis/itwin-entities/v1/apiName.md @@ -0,0 +1 @@ +itwin-entities diff --git a/apis/itwin-entities/v1/title.md b/apis/itwin-entities/v1/title.md new file mode 100644 index 0000000..91b48c4 --- /dev/null +++ b/apis/itwin-entities/v1/title.md @@ -0,0 +1 @@ +iTwin Entities diff --git a/apis/itwin-search/v1/apiName.md b/apis/itwin-search/v1/apiName.md new file mode 100644 index 0000000..988161a --- /dev/null +++ b/apis/itwin-search/v1/apiName.md @@ -0,0 +1 @@ +itwin-search diff --git a/apis/itwin-search/v1/title.md b/apis/itwin-search/v1/title.md new file mode 100644 index 0000000..b7f8197 --- /dev/null +++ b/apis/itwin-search/v1/title.md @@ -0,0 +1 @@ +iTwin Search diff --git a/apis/itwins/v1/apiName.md b/apis/itwins/v1/apiName.md new file mode 100644 index 0000000..c0af2cf --- /dev/null +++ b/apis/itwins/v1/apiName.md @@ -0,0 +1 @@ +itwins diff --git a/apis/itwins/v1/title.md b/apis/itwins/v1/title.md new file mode 100644 index 0000000..e279631 --- /dev/null +++ b/apis/itwins/v1/title.md @@ -0,0 +1 @@ +iTwins diff --git a/apis/library/v1/apiName.md b/apis/library/v1/apiName.md new file mode 100644 index 0000000..14d6358 --- /dev/null +++ b/apis/library/v1/apiName.md @@ -0,0 +1 @@ +library diff --git a/apis/library/v1/title.md b/apis/library/v1/title.md new file mode 100644 index 0000000..7728246 --- /dev/null +++ b/apis/library/v1/title.md @@ -0,0 +1 @@ +Library diff --git a/apis/mesh-export/v1/apiName.md b/apis/mesh-export/v1/apiName.md new file mode 100644 index 0000000..1140550 --- /dev/null +++ b/apis/mesh-export/v1/apiName.md @@ -0,0 +1 @@ +mesh-export diff --git a/apis/mesh-export/v1/title.md b/apis/mesh-export/v1/title.md new file mode 100644 index 0000000..e8ffca6 --- /dev/null +++ b/apis/mesh-export/v1/title.md @@ -0,0 +1 @@ +Mesh Export diff --git a/apis/named-groups/v1/apiName.md b/apis/named-groups/v1/apiName.md new file mode 100644 index 0000000..22684fd --- /dev/null +++ b/apis/named-groups/v1/apiName.md @@ -0,0 +1 @@ +named-groups diff --git a/apis/named-groups/v1/title.md b/apis/named-groups/v1/title.md new file mode 100644 index 0000000..4844570 --- /dev/null +++ b/apis/named-groups/v1/title.md @@ -0,0 +1 @@ +Named Groups diff --git a/apis/pnid-to-itwin/v2/apiName.md b/apis/pnid-to-itwin/v2/apiName.md new file mode 100644 index 0000000..d2fe437 --- /dev/null +++ b/apis/pnid-to-itwin/v2/apiName.md @@ -0,0 +1 @@ +pnid-to-itwin-v2 diff --git a/apis/pnid-to-itwin/v2/title.md b/apis/pnid-to-itwin/v2/title.md new file mode 100644 index 0000000..9cf0c0e --- /dev/null +++ b/apis/pnid-to-itwin/v2/title.md @@ -0,0 +1 @@ +PnID to iTwin diff --git a/apis/projects/v1/apiName.md b/apis/projects/v1/apiName.md new file mode 100644 index 0000000..7201f8c --- /dev/null +++ b/apis/projects/v1/apiName.md @@ -0,0 +1 @@ +projects diff --git a/apis/projects/v1/title.md b/apis/projects/v1/title.md new file mode 100644 index 0000000..c07db15 --- /dev/null +++ b/apis/projects/v1/title.md @@ -0,0 +1 @@ +Projects diff --git a/apis/projectwise365-insights/v1/apiName.md b/apis/projectwise365-insights/v1/apiName.md new file mode 100644 index 0000000..d8d601d --- /dev/null +++ b/apis/projectwise365-insights/v1/apiName.md @@ -0,0 +1 @@ +projectwise365-insights diff --git a/apis/projectwise365-insights/v1/title.md b/apis/projectwise365-insights/v1/title.md new file mode 100644 index 0000000..7150ff5 --- /dev/null +++ b/apis/projectwise365-insights/v1/title.md @@ -0,0 +1 @@ +ProjectWise 365 Insights diff --git a/apis/reality-data/v1/apiName.md b/apis/reality-data/v1/apiName.md new file mode 100644 index 0000000..babff78 --- /dev/null +++ b/apis/reality-data/v1/apiName.md @@ -0,0 +1 @@ +reality-data diff --git a/apis/reality-data/v1/title.md b/apis/reality-data/v1/title.md new file mode 100644 index 0000000..1034916 --- /dev/null +++ b/apis/reality-data/v1/title.md @@ -0,0 +1 @@ +Reality Data diff --git a/apis/reality-management/v1/apiName.md b/apis/reality-management/v1/apiName.md new file mode 100644 index 0000000..73e815e --- /dev/null +++ b/apis/reality-management/v1/apiName.md @@ -0,0 +1 @@ +reality-management diff --git a/apis/reality-management/v1/title.md b/apis/reality-management/v1/title.md new file mode 100644 index 0000000..5a27743 --- /dev/null +++ b/apis/reality-management/v1/title.md @@ -0,0 +1 @@ +Reality Management diff --git a/apis/realityconversion/v1/apiName.md b/apis/realityconversion/v1/apiName.md new file mode 100644 index 0000000..163742a --- /dev/null +++ b/apis/realityconversion/v1/apiName.md @@ -0,0 +1 @@ +realityconversion diff --git a/apis/realityconversion/v1/title.md b/apis/realityconversion/v1/title.md new file mode 100644 index 0000000..be9d6d2 --- /dev/null +++ b/apis/realityconversion/v1/title.md @@ -0,0 +1 @@ +Reality Conversion diff --git a/apis/realitydataanalysis/v1/apiName.md b/apis/realitydataanalysis/v1/apiName.md new file mode 100644 index 0000000..6f40dfe --- /dev/null +++ b/apis/realitydataanalysis/v1/apiName.md @@ -0,0 +1 @@ +realitydataanalysis diff --git a/apis/realitydataanalysis/v1/title.md b/apis/realitydataanalysis/v1/title.md new file mode 100644 index 0000000..de74db0 --- /dev/null +++ b/apis/realitydataanalysis/v1/title.md @@ -0,0 +1 @@ +Reality Analysis diff --git a/apis/reporting/v2/apiName.md b/apis/reporting/v2/apiName.md new file mode 100644 index 0000000..de4207b --- /dev/null +++ b/apis/reporting/v2/apiName.md @@ -0,0 +1 @@ +insights-v2 diff --git a/apis/reporting/v2/title.md b/apis/reporting/v2/title.md new file mode 100644 index 0000000..c889573 --- /dev/null +++ b/apis/reporting/v2/title.md @@ -0,0 +1 @@ +Reporting diff --git a/apis/savedviews/v1/apiName.md b/apis/savedviews/v1/apiName.md new file mode 100644 index 0000000..46f73df --- /dev/null +++ b/apis/savedviews/v1/apiName.md @@ -0,0 +1 @@ +savedviews diff --git a/apis/savedviews/v1/title.md b/apis/savedviews/v1/title.md new file mode 100644 index 0000000..cba43de --- /dev/null +++ b/apis/savedviews/v1/title.md @@ -0,0 +1 @@ +Saved Views diff --git a/apis/sensor-data-websocket/v1/apiName.md b/apis/sensor-data-websocket/v1/apiName.md new file mode 100644 index 0000000..8d03623 --- /dev/null +++ b/apis/sensor-data-websocket/v1/apiName.md @@ -0,0 +1 @@ +sensor-data-websocket diff --git a/apis/sensor-data-websocket/v1/title.md b/apis/sensor-data-websocket/v1/title.md new file mode 100644 index 0000000..6af0e5d --- /dev/null +++ b/apis/sensor-data-websocket/v1/title.md @@ -0,0 +1 @@ +Sensor Data WebSocket diff --git a/apis/sensor-data/v1/apiName.md b/apis/sensor-data/v1/apiName.md new file mode 100644 index 0000000..e6959c4 --- /dev/null +++ b/apis/sensor-data/v1/apiName.md @@ -0,0 +1 @@ +sensor-data diff --git a/apis/sensor-data/v1/title.md b/apis/sensor-data/v1/title.md new file mode 100644 index 0000000..79dd0a5 --- /dev/null +++ b/apis/sensor-data/v1/title.md @@ -0,0 +1 @@ +Sensor Data diff --git a/apis/storage-container/v1/apiName.md b/apis/storage-container/v1/apiName.md new file mode 100644 index 0000000..77689ff --- /dev/null +++ b/apis/storage-container/v1/apiName.md @@ -0,0 +1 @@ +storage-container diff --git a/apis/storage-container/v1/title.md b/apis/storage-container/v1/title.md new file mode 100644 index 0000000..0d0e29f --- /dev/null +++ b/apis/storage-container/v1/title.md @@ -0,0 +1 @@ +Storage Container diff --git a/apis/storage/v1/apiName.md b/apis/storage/v1/apiName.md new file mode 100644 index 0000000..fa780e2 --- /dev/null +++ b/apis/storage/v1/apiName.md @@ -0,0 +1 @@ +storage diff --git a/apis/storage/v1/title.md b/apis/storage/v1/title.md new file mode 100644 index 0000000..f12faf5 --- /dev/null +++ b/apis/storage/v1/title.md @@ -0,0 +1 @@ +Storage diff --git a/apis/synchronization/v1/apiName.md b/apis/synchronization/v1/apiName.md new file mode 100644 index 0000000..3abca95 --- /dev/null +++ b/apis/synchronization/v1/apiName.md @@ -0,0 +1 @@ +synchronization diff --git a/apis/synchronization/v1/title.md b/apis/synchronization/v1/title.md new file mode 100644 index 0000000..368bfcd --- /dev/null +++ b/apis/synchronization/v1/title.md @@ -0,0 +1 @@ +Synchronization diff --git a/apis/transformations/v1/apiName.md b/apis/transformations/v1/apiName.md new file mode 100644 index 0000000..a6d3c52 --- /dev/null +++ b/apis/transformations/v1/apiName.md @@ -0,0 +1 @@ +transformations diff --git a/apis/transformations/v1/title.md b/apis/transformations/v1/title.md new file mode 100644 index 0000000..0faf38c --- /dev/null +++ b/apis/transformations/v1/title.md @@ -0,0 +1 @@ +Transformations diff --git a/apis/users/v1/apiName.md b/apis/users/v1/apiName.md new file mode 100644 index 0000000..ae22583 --- /dev/null +++ b/apis/users/v1/apiName.md @@ -0,0 +1 @@ +users diff --git a/apis/users/v1/title.md b/apis/users/v1/title.md new file mode 100644 index 0000000..f3d929a --- /dev/null +++ b/apis/users/v1/title.md @@ -0,0 +1 @@ +Users diff --git a/apis/validation/v1/apiName.md b/apis/validation/v1/apiName.md new file mode 100644 index 0000000..d45b2de --- /dev/null +++ b/apis/validation/v1/apiName.md @@ -0,0 +1 @@ +validation diff --git a/apis/validation/v1/title.md b/apis/validation/v1/title.md new file mode 100644 index 0000000..5505e5b --- /dev/null +++ b/apis/validation/v1/title.md @@ -0,0 +1 @@ +Property Validation diff --git a/apis/webhooks/v2/apiName.md b/apis/webhooks/v2/apiName.md new file mode 100644 index 0000000..7797b68 --- /dev/null +++ b/apis/webhooks/v2/apiName.md @@ -0,0 +1 @@ +webhooks-v2 diff --git a/apis/webhooks/v2/title.md b/apis/webhooks/v2/title.md new file mode 100644 index 0000000..d222512 --- /dev/null +++ b/apis/webhooks/v2/title.md @@ -0,0 +1 @@ +Webhooks From b4e49026e916821f599262a0729b97831dd4a24c Mon Sep 17 00:00:00 2001 From: Linas B Date: Wed, 4 Sep 2024 22:24:33 +0300 Subject: [PATCH 4/5] removed v2 --- apis/v2/description.md | 1 - .../add-itwin-group-members/description.md | 11 ------ .../add-itwin-group-members/displayName.md | 1 - .../add-itwin-owner-member/description.md | 15 -------- .../add-itwin-owner-member/displayName.md | 1 - .../add-itwin-user-members/description.md | 13 ------- .../add-itwin-user-members/displayName.md | 1 - .../create-iTwin-role/description.md | 9 ----- .../create-iTwin-role/displayName.md | 1 - .../create-itwin-group/description.md | 15 -------- .../create-itwin-group/displayName.md | 1 - .../create-itwin-job/description.md | 19 ----------- .../create-itwin-job/displayName.md | 1 - .../delete-iTwin-role/description.md | 9 ----- .../delete-iTwin-role/displayName.md | 1 - .../delete-itwin-group/description.md | 15 -------- .../delete-itwin-group/displayName.md | 1 - .../get-all-permissions/description.md | 11 ------ .../get-all-permissions/displayName.md | 1 - .../get-iTwin-permissions/description.md | 11 ------ .../get-iTwin-permissions/displayName.md | 1 - .../operations/get-iTwin-roles/description.md | 9 ----- .../operations/get-iTwin-roles/displayName.md | 1 - .../get-itwin-group-member/description.md | 13 ------- .../get-itwin-group-member/displayName.md | 1 - .../get-itwin-group-members/description.md | 13 ------- .../get-itwin-group-members/displayName.md | 1 - .../operations/get-itwin-group/description.md | 13 ------- .../operations/get-itwin-group/displayName.md | 1 - .../get-itwin-groups/description.md | 13 ------- .../get-itwin-groups/displayName.md | 1 - .../get-itwin-job-actions/description.md | 9 ----- .../get-itwin-job-actions/displayName.md | 1 - .../operations/get-itwin-job/description.md | 18 ---------- .../operations/get-itwin-job/displayName.md | 1 - .../description.md | 13 ------- .../displayName.md | 1 - .../get-itwin-owner-members/description.md | 34 ------------------- .../get-itwin-owner-members/displayName.md | 1 - .../operations/get-itwin-role/description.md | 9 ----- .../operations/get-itwin-role/displayName.md | 1 - .../get-itwin-user-member/description.md | 34 ------------------- .../get-itwin-user-member/displayName.md | 1 - .../get-itwin-user-members/description.md | 34 ------------------- .../get-itwin-user-members/displayName.md | 1 - .../remove-itwin-group-member/description.md | 9 ----- .../remove-itwin-group-member/displayName.md | 1 - .../remove-itwin-owner-member/description.md | 11 ------ .../remove-itwin-owner-member/displayName.md | 1 - .../remove-itwin-user-member/description.md | 9 ----- .../remove-itwin-user-member/displayName.md | 1 - .../update-iTwin-role/description.md | 9 ----- .../update-iTwin-role/displayName.md | 1 - .../update-itwin-group-member/description.md | 9 ----- .../update-itwin-group-member/displayName.md | 1 - .../update-itwin-group/description.md | 17 ---------- .../update-itwin-group/displayName.md | 1 - .../update-itwin-user-member/description.md | 9 ----- .../update-itwin-user-member/displayName.md | 1 - 59 files changed, 443 deletions(-) delete mode 100644 apis/v2/description.md delete mode 100644 apis/v2/operations/add-itwin-group-members/description.md delete mode 100644 apis/v2/operations/add-itwin-group-members/displayName.md delete mode 100644 apis/v2/operations/add-itwin-owner-member/description.md delete mode 100644 apis/v2/operations/add-itwin-owner-member/displayName.md delete mode 100644 apis/v2/operations/add-itwin-user-members/description.md delete mode 100644 apis/v2/operations/add-itwin-user-members/displayName.md delete mode 100644 apis/v2/operations/create-iTwin-role/description.md delete mode 100644 apis/v2/operations/create-iTwin-role/displayName.md delete mode 100644 apis/v2/operations/create-itwin-group/description.md delete mode 100644 apis/v2/operations/create-itwin-group/displayName.md delete mode 100644 apis/v2/operations/create-itwin-job/description.md delete mode 100644 apis/v2/operations/create-itwin-job/displayName.md delete mode 100644 apis/v2/operations/delete-iTwin-role/description.md delete mode 100644 apis/v2/operations/delete-iTwin-role/displayName.md delete mode 100644 apis/v2/operations/delete-itwin-group/description.md delete mode 100644 apis/v2/operations/delete-itwin-group/displayName.md delete mode 100644 apis/v2/operations/get-all-permissions/description.md delete mode 100644 apis/v2/operations/get-all-permissions/displayName.md delete mode 100644 apis/v2/operations/get-iTwin-permissions/description.md delete mode 100644 apis/v2/operations/get-iTwin-permissions/displayName.md delete mode 100644 apis/v2/operations/get-iTwin-roles/description.md delete mode 100644 apis/v2/operations/get-iTwin-roles/displayName.md delete mode 100644 apis/v2/operations/get-itwin-group-member/description.md delete mode 100644 apis/v2/operations/get-itwin-group-member/displayName.md delete mode 100644 apis/v2/operations/get-itwin-group-members/description.md delete mode 100644 apis/v2/operations/get-itwin-group-members/displayName.md delete mode 100644 apis/v2/operations/get-itwin-group/description.md delete mode 100644 apis/v2/operations/get-itwin-group/displayName.md delete mode 100644 apis/v2/operations/get-itwin-groups/description.md delete mode 100644 apis/v2/operations/get-itwin-groups/displayName.md delete mode 100644 apis/v2/operations/get-itwin-job-actions/description.md delete mode 100644 apis/v2/operations/get-itwin-job-actions/displayName.md delete mode 100644 apis/v2/operations/get-itwin-job/description.md delete mode 100644 apis/v2/operations/get-itwin-job/displayName.md delete mode 100644 apis/v2/operations/get-itwin-member-invitations/description.md delete mode 100644 apis/v2/operations/get-itwin-member-invitations/displayName.md delete mode 100644 apis/v2/operations/get-itwin-owner-members/description.md delete mode 100644 apis/v2/operations/get-itwin-owner-members/displayName.md delete mode 100644 apis/v2/operations/get-itwin-role/description.md delete mode 100644 apis/v2/operations/get-itwin-role/displayName.md delete mode 100644 apis/v2/operations/get-itwin-user-member/description.md delete mode 100644 apis/v2/operations/get-itwin-user-member/displayName.md delete mode 100644 apis/v2/operations/get-itwin-user-members/description.md delete mode 100644 apis/v2/operations/get-itwin-user-members/displayName.md delete mode 100644 apis/v2/operations/remove-itwin-group-member/description.md delete mode 100644 apis/v2/operations/remove-itwin-group-member/displayName.md delete mode 100644 apis/v2/operations/remove-itwin-owner-member/description.md delete mode 100644 apis/v2/operations/remove-itwin-owner-member/displayName.md delete mode 100644 apis/v2/operations/remove-itwin-user-member/description.md delete mode 100644 apis/v2/operations/remove-itwin-user-member/displayName.md delete mode 100644 apis/v2/operations/update-iTwin-role/description.md delete mode 100644 apis/v2/operations/update-iTwin-role/displayName.md delete mode 100644 apis/v2/operations/update-itwin-group-member/description.md delete mode 100644 apis/v2/operations/update-itwin-group-member/displayName.md delete mode 100644 apis/v2/operations/update-itwin-group/description.md delete mode 100644 apis/v2/operations/update-itwin-group/displayName.md delete mode 100644 apis/v2/operations/update-itwin-user-member/description.md delete mode 100644 apis/v2/operations/update-itwin-user-member/displayName.md diff --git a/apis/v2/description.md b/apis/v2/description.md deleted file mode 100644 index 667782e..0000000 --- a/apis/v2/description.md +++ /dev/null @@ -1 +0,0 @@ -Manage Access Controls for your iTwin member using iTwin roles and permissions. \ No newline at end of file diff --git a/apis/v2/operations/add-itwin-group-members/description.md b/apis/v2/operations/add-itwin-group-members/description.md deleted file mode 100644 index b012ef9..0000000 --- a/apis/v2/operations/add-itwin-group-members/description.md +++ /dev/null @@ -1,11 +0,0 @@ ---- - -Add new iTwin group members - -The total number of roles assigned in this request must not exceed 50. This can be achieved with many different configurations. For example, 1 role can be assigned to 50 groups, or 5 roles can be assigned to 10 groups, both resulting in 50 role assignments. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/add-itwin-group-members/displayName.md b/apis/v2/operations/add-itwin-group-members/displayName.md deleted file mode 100644 index 68c1b77..0000000 --- a/apis/v2/operations/add-itwin-group-members/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Add iTwin group members \ No newline at end of file diff --git a/apis/v2/operations/add-itwin-owner-member/description.md b/apis/v2/operations/add-itwin-owner-member/description.md deleted file mode 100644 index 934fc92..0000000 --- a/apis/v2/operations/add-itwin-owner-member/description.md +++ /dev/null @@ -1,15 +0,0 @@ ---- - -Add new iTwin owner members. iTwin Owners are users which have full control over the iTwin. Each owner is granted all permissions on the iTwin, allowing them to perform any action on the iTwin they own. - -Users which are external (i.e. not in the same organization as the iTwin) are not automatically added to the iTwin. Instead, they're invited. Users which are not external, are immediately added as members on the iTwin. - -Invited individuals will recieve an invitation via Email, where they'll be prompted to accept the invitation. Upon accepting, they'll then become a member of the iTwin. - -{!Authorization.md!} - -You must be an owner to add other owners. - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/add-itwin-owner-member/displayName.md b/apis/v2/operations/add-itwin-owner-member/displayName.md deleted file mode 100644 index 45ee905..0000000 --- a/apis/v2/operations/add-itwin-owner-member/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Add iTwin owner member \ No newline at end of file diff --git a/apis/v2/operations/add-itwin-user-members/description.md b/apis/v2/operations/add-itwin-user-members/description.md deleted file mode 100644 index 2fa089c..0000000 --- a/apis/v2/operations/add-itwin-user-members/description.md +++ /dev/null @@ -1,13 +0,0 @@ ---- - -Add or Invite new iTwin user members. Users which are external (i.e. not in the same organization as the iTwin) are not automatically added to the iTwin. Instead, they're invited. Users which are not external, are immediately added as members on the iTwin. - -Invited individuals will recieve an invitation via Email, where they'll be prompted to accept the invitation. Upon accepting, they'll then become a member of the iTwin. - -The total number of roles assigned in this request must not exceed 50. This can be achieved with many different configurations. For example, 1 role can be assigned to 50 users, or 5 roles can be assigned to 10 users, both resulting in 50 role assignments. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/add-itwin-user-members/displayName.md b/apis/v2/operations/add-itwin-user-members/displayName.md deleted file mode 100644 index 0e28ddd..0000000 --- a/apis/v2/operations/add-itwin-user-members/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Add iTwin user members \ No newline at end of file diff --git a/apis/v2/operations/create-iTwin-role/description.md b/apis/v2/operations/create-iTwin-role/description.md deleted file mode 100644 index 721da6d..0000000 --- a/apis/v2/operations/create-iTwin-role/description.md +++ /dev/null @@ -1,9 +0,0 @@ ---- - -Create a new iTwin role. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/create-iTwin-role/displayName.md b/apis/v2/operations/create-iTwin-role/displayName.md deleted file mode 100644 index cd6904e..0000000 --- a/apis/v2/operations/create-iTwin-role/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Create iTwin role \ No newline at end of file diff --git a/apis/v2/operations/create-itwin-group/description.md b/apis/v2/operations/create-itwin-group/description.md deleted file mode 100644 index f0696c0..0000000 --- a/apis/v2/operations/create-itwin-group/description.md +++ /dev/null @@ -1,15 +0,0 @@ ---- - -Create a new iTwin group. - -{!Authorization.md!} - -### Authorization - -A user can create a Group by being assigned the `administration_manage_groups` on the iTwin level. A user also can create a Group on an iTwin by either being an Organization Administrator for the Organization that owns the given iTwin, or an owner of the iTwin. - -For creation of Groups on the Account iTwin, the user must be an Organization Administrator for the Organization. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. - ---- diff --git a/apis/v2/operations/create-itwin-group/displayName.md b/apis/v2/operations/create-itwin-group/displayName.md deleted file mode 100644 index c9628f1..0000000 --- a/apis/v2/operations/create-itwin-group/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Create iTwin group \ No newline at end of file diff --git a/apis/v2/operations/create-itwin-job/description.md b/apis/v2/operations/create-itwin-job/description.md deleted file mode 100644 index fbd6cb7..0000000 --- a/apis/v2/operations/create-itwin-job/description.md +++ /dev/null @@ -1,19 +0,0 @@ ---- - -Create a new iTwin job. iTwin jobs allow you to preform actions on an iTwin in bulk. - -Currently there are three types of supported actions: - -- `assignRoles` -- `unassignRoles` -- `removeMembers` - -Note: If the user being assigned roles in the `assignRoles` action is not a member of the iTwin, they will be added to the iTwin with the provided roles. - -`assignRoles` and `unassignRoles` actions have a limit of 100 roles per group of actions. `removeMembers` has a limit of 100 emails. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/create-itwin-job/displayName.md b/apis/v2/operations/create-itwin-job/displayName.md deleted file mode 100644 index 51f8b3e..0000000 --- a/apis/v2/operations/create-itwin-job/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Create iTwin job \ No newline at end of file diff --git a/apis/v2/operations/delete-iTwin-role/description.md b/apis/v2/operations/delete-iTwin-role/description.md deleted file mode 100644 index 92734fe..0000000 --- a/apis/v2/operations/delete-iTwin-role/description.md +++ /dev/null @@ -1,9 +0,0 @@ ---- - -Delete the specified iTwin role. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/delete-iTwin-role/displayName.md b/apis/v2/operations/delete-iTwin-role/displayName.md deleted file mode 100644 index 6792532..0000000 --- a/apis/v2/operations/delete-iTwin-role/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Delete iTwin role \ No newline at end of file diff --git a/apis/v2/operations/delete-itwin-group/description.md b/apis/v2/operations/delete-itwin-group/description.md deleted file mode 100644 index f0e28b7..0000000 --- a/apis/v2/operations/delete-itwin-group/description.md +++ /dev/null @@ -1,15 +0,0 @@ ---- - -Delete the specified iTwin group. - -{!Authorization.md!} - -### Authorization - -A user can delete a Group by being assigned the `administration_manage_groups` on the iTwin level. A user also can delete a Group on an iTwin by either being an Organization Administrator for the Organization that owns the given iTwin, or an owner of the iTwin. - -For deletion of Groups on the Account iTwin, the user must be an Organization Administrator for the Organization. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. - ---- diff --git a/apis/v2/operations/delete-itwin-group/displayName.md b/apis/v2/operations/delete-itwin-group/displayName.md deleted file mode 100644 index 2385fef..0000000 --- a/apis/v2/operations/delete-itwin-group/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Delete iTwin group \ No newline at end of file diff --git a/apis/v2/operations/get-all-permissions/description.md b/apis/v2/operations/get-all-permissions/description.md deleted file mode 100644 index 2f8242f..0000000 --- a/apis/v2/operations/get-all-permissions/description.md +++ /dev/null @@ -1,11 +0,0 @@ ---- - -Retrieves the list of all available permissions - -{!Authorization.md!} - -### Authorization - -No Authorization is required for this API call. - ---- diff --git a/apis/v2/operations/get-all-permissions/displayName.md b/apis/v2/operations/get-all-permissions/displayName.md deleted file mode 100644 index 3d98619..0000000 --- a/apis/v2/operations/get-all-permissions/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get all permissions \ No newline at end of file diff --git a/apis/v2/operations/get-iTwin-permissions/description.md b/apis/v2/operations/get-iTwin-permissions/description.md deleted file mode 100644 index 5f31273..0000000 --- a/apis/v2/operations/get-iTwin-permissions/description.md +++ /dev/null @@ -1,11 +0,0 @@ ---- - -Retrieves a list of permissions the calling user has on a specified iTwin. - -{!Authorization.md!} - -### Authorization - -No Authorization is required for this API call. - ---- \ No newline at end of file diff --git a/apis/v2/operations/get-iTwin-permissions/displayName.md b/apis/v2/operations/get-iTwin-permissions/displayName.md deleted file mode 100644 index 49a6b26..0000000 --- a/apis/v2/operations/get-iTwin-permissions/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get my iTwin permissions \ No newline at end of file diff --git a/apis/v2/operations/get-iTwin-roles/description.md b/apis/v2/operations/get-iTwin-roles/description.md deleted file mode 100644 index 1bb922d..0000000 --- a/apis/v2/operations/get-iTwin-roles/description.md +++ /dev/null @@ -1,9 +0,0 @@ ---- - -Retrieves a list of available user roles that are defined for a specified iTwin. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/get-iTwin-roles/displayName.md b/apis/v2/operations/get-iTwin-roles/displayName.md deleted file mode 100644 index 5192c0f..0000000 --- a/apis/v2/operations/get-iTwin-roles/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin roles \ No newline at end of file diff --git a/apis/v2/operations/get-itwin-group-member/description.md b/apis/v2/operations/get-itwin-group-member/description.md deleted file mode 100644 index 6423da3..0000000 --- a/apis/v2/operations/get-itwin-group-member/description.md +++ /dev/null @@ -1,13 +0,0 @@ ---- - -Retrieves a specific group member for a specified iTwin. - -{!Authorization.md!} - -### Authorization - -The calling user must be a member of the iTwin. Organization Administrator can also retrieve an iTwin member for any iTwin in their Organization. - -{!OrganizationAdministrator.md!} - ---- diff --git a/apis/v2/operations/get-itwin-group-member/displayName.md b/apis/v2/operations/get-itwin-group-member/displayName.md deleted file mode 100644 index e9903b7..0000000 --- a/apis/v2/operations/get-itwin-group-member/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin group member \ No newline at end of file diff --git a/apis/v2/operations/get-itwin-group-members/description.md b/apis/v2/operations/get-itwin-group-members/description.md deleted file mode 100644 index 438c5f6..0000000 --- a/apis/v2/operations/get-itwin-group-members/description.md +++ /dev/null @@ -1,13 +0,0 @@ ---- - -Retrieves a list of iTwin group members and their roles assignments. - -{!Authorization.md!} - -### Authorization - -The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin members for any iTwin in their Organization. - -{!OrganizationAdministrator.md!} - ---- diff --git a/apis/v2/operations/get-itwin-group-members/displayName.md b/apis/v2/operations/get-itwin-group-members/displayName.md deleted file mode 100644 index ebfde9f..0000000 --- a/apis/v2/operations/get-itwin-group-members/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin group members \ No newline at end of file diff --git a/apis/v2/operations/get-itwin-group/description.md b/apis/v2/operations/get-itwin-group/description.md deleted file mode 100644 index 2f8f763..0000000 --- a/apis/v2/operations/get-itwin-group/description.md +++ /dev/null @@ -1,13 +0,0 @@ ---- - -Retrieves the specified group for the specified iTwin. The `members` and `imsGroups` properties are both capped at 50 each. - -{!Authorization.md!} - -### Authorization - -User must be an Organization Administrator for the Organization that owns the given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. - ---- diff --git a/apis/v2/operations/get-itwin-group/displayName.md b/apis/v2/operations/get-itwin-group/displayName.md deleted file mode 100644 index 9c3cb9f..0000000 --- a/apis/v2/operations/get-itwin-group/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin group \ No newline at end of file diff --git a/apis/v2/operations/get-itwin-groups/description.md b/apis/v2/operations/get-itwin-groups/description.md deleted file mode 100644 index 479afeb..0000000 --- a/apis/v2/operations/get-itwin-groups/description.md +++ /dev/null @@ -1,13 +0,0 @@ ---- - -Retrieves a list of all groups that are defined for a specified iTwin. The `members` and `imsGroups` properties are both capped at 50 each. - -{!Authorization.md!} - -### Authorization - -User must be an Organization Administrator for the Organization that owns the given iTwin. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page. - ---- diff --git a/apis/v2/operations/get-itwin-groups/displayName.md b/apis/v2/operations/get-itwin-groups/displayName.md deleted file mode 100644 index 3b2c4d1..0000000 --- a/apis/v2/operations/get-itwin-groups/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin groups \ No newline at end of file diff --git a/apis/v2/operations/get-itwin-job-actions/description.md b/apis/v2/operations/get-itwin-job-actions/description.md deleted file mode 100644 index 6660bc9..0000000 --- a/apis/v2/operations/get-itwin-job-actions/description.md +++ /dev/null @@ -1,9 +0,0 @@ ---- - -Retrieves the iTwin job actions for the specified iTwin job for the specified iTwin. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/get-itwin-job-actions/displayName.md b/apis/v2/operations/get-itwin-job-actions/displayName.md deleted file mode 100644 index 6cfd93e..0000000 --- a/apis/v2/operations/get-itwin-job-actions/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin job actions \ No newline at end of file diff --git a/apis/v2/operations/get-itwin-job/description.md b/apis/v2/operations/get-itwin-job/description.md deleted file mode 100644 index 8b58d44..0000000 --- a/apis/v2/operations/get-itwin-job/description.md +++ /dev/null @@ -1,18 +0,0 @@ ---- - -Retrieves the specified iTwin job for the specified iTwin. - -By default this operation will only return the `status` of the iTwin job. To find the specific errors of the iTwin job, include `return=representation` in the `Prefer` header. - -### Status - -- `Active`: iTwin job is stil in progress. -- `Completed`: iTwin job completed without error. -- `PartialCompleted`: iTwin job completed with some actions failing. To find the specific errors of the iTwin job, include `return=representation` in the `Prefer` header. -- `Failed`: iTwin job completed with all actions failing. To find the specific errors of the iTwin job, include `return=representation` in the `Prefer` header. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/get-itwin-job/displayName.md b/apis/v2/operations/get-itwin-job/displayName.md deleted file mode 100644 index 3fcab99..0000000 --- a/apis/v2/operations/get-itwin-job/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin job \ No newline at end of file diff --git a/apis/v2/operations/get-itwin-member-invitations/description.md b/apis/v2/operations/get-itwin-member-invitations/description.md deleted file mode 100644 index 579b70c..0000000 --- a/apis/v2/operations/get-itwin-member-invitations/description.md +++ /dev/null @@ -1,13 +0,0 @@ ---- - -Retrieves a list of iTwin member invitations. By default, users will receive the invitations they have sent. If the user is an iTwin Owner, they will receive all invitations for the iTwin. - -Invitations have an expiration of 7 days after their creation. Once that expiration passes, the invitation will not be returned. - -### Authorization - -The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin member invitations for any iTwin in their Organization. - -{!OrganizationAdministrator.md!} - ---- diff --git a/apis/v2/operations/get-itwin-member-invitations/displayName.md b/apis/v2/operations/get-itwin-member-invitations/displayName.md deleted file mode 100644 index f6be40a..0000000 --- a/apis/v2/operations/get-itwin-member-invitations/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin member invitations \ No newline at end of file diff --git a/apis/v2/operations/get-itwin-owner-members/description.md b/apis/v2/operations/get-itwin-owner-members/description.md deleted file mode 100644 index fa5bbf9..0000000 --- a/apis/v2/operations/get-itwin-owner-members/description.md +++ /dev/null @@ -1,34 +0,0 @@ ---- - -Retrieves a list of iTwin owner members. iTwin Owners are users which have full control over the iTwin. Each owner is granted all permissions on the iTwin, allowing them to perform any action on the iTwin they own. - -### Missing Users - -When members are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a member of the iTwin. When this happens, the user member will be returned from this API endpoint with the follow values: -``` -{ - "id": , - "email": null, - "givenName": null, - "surname": null, - "organization": null, - ... -} -``` -You should account for this in your software if you do not want to show these users. - -#### Cleanup - -The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient. - -If not, you can use the [Remove iTwin Owner Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-owner-member/) API (use the memberId) to remove the owner member from the iTwin. - -{!Authorization.md!} - -### Authorization - -The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin owner members for any iTwin in their Organization. - -{!OrganizationAdministrator.md!} - ---- diff --git a/apis/v2/operations/get-itwin-owner-members/displayName.md b/apis/v2/operations/get-itwin-owner-members/displayName.md deleted file mode 100644 index bff08bc..0000000 --- a/apis/v2/operations/get-itwin-owner-members/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin owner members \ No newline at end of file diff --git a/apis/v2/operations/get-itwin-role/description.md b/apis/v2/operations/get-itwin-role/description.md deleted file mode 100644 index 6ba0a3e..0000000 --- a/apis/v2/operations/get-itwin-role/description.md +++ /dev/null @@ -1,9 +0,0 @@ ---- - -Retrieves the specified role for the specified iTwin. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/get-itwin-role/displayName.md b/apis/v2/operations/get-itwin-role/displayName.md deleted file mode 100644 index 234e61f..0000000 --- a/apis/v2/operations/get-itwin-role/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin role \ No newline at end of file diff --git a/apis/v2/operations/get-itwin-user-member/description.md b/apis/v2/operations/get-itwin-user-member/description.md deleted file mode 100644 index 25c722b..0000000 --- a/apis/v2/operations/get-itwin-user-member/description.md +++ /dev/null @@ -1,34 +0,0 @@ ---- - -Retrieves a specific user member for a specified iTwin. - -### Missing Users - -When users are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a user member of the iTwin. When this happens, the user member will be returned from this API endpoint with the follow values: -``` -{ - "id": , - "email": null, - "givenName": null, - "surname": null, - "organization": null, - ... -} -``` -You should account for this in your software if you do not want to show these users. - -#### Cleanup - -The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient. - -If not, you can use the [Remove iTwin User Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-user-member/) API (use the memberId) to remove the user member from the iTwin. - -{!Authorization.md!} - -### Authorization - -The calling user must be a member of the iTwin. Organization Administrator can also retrieve an iTwin user member for any iTwin in their Organization. - -{!OrganizationAdministrator.md!} - ---- diff --git a/apis/v2/operations/get-itwin-user-member/displayName.md b/apis/v2/operations/get-itwin-user-member/displayName.md deleted file mode 100644 index 214f53f..0000000 --- a/apis/v2/operations/get-itwin-user-member/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin user member \ No newline at end of file diff --git a/apis/v2/operations/get-itwin-user-members/description.md b/apis/v2/operations/get-itwin-user-members/description.md deleted file mode 100644 index 032493a..0000000 --- a/apis/v2/operations/get-itwin-user-members/description.md +++ /dev/null @@ -1,34 +0,0 @@ ---- - -Retrieves a list of iTwin user members and their roles assignments. - -### Missing Users - -When members are removed from the Bentley Identity Management System, they are not automatically removed from the iTwin. Therefore, it is possible to have a situation where the user is no longer valid, yet they are still a member of the iTwin. When this happens, the user member will be returned from this API endpoint with the follow values: -``` -{ - "id": , - "email": null, - "givenName": null, - "surname": null, - "organization": null, - ... -} -``` -You should account for this in your software if you do not want to show these users. - -#### Cleanup - -The Access Control API will perform a once-a-week cleanup to remove these "Missing Users". You can rely on this automated clean-up if this timeline is sufficient. - -If not, you can use the [Remove iTwin User Member](https://developer.bentley.com/apis/access-control/operations/remove-iTwin-user-member/) API (use the memberId) to remove the user member from the iTwin. - -{!Authorization.md!} - -### Authorization - -The calling user must be a member of the iTwin. Organization Administrator can also retrieve iTwin user members for any iTwin in their Organization. - -{!OrganizationAdministrator.md!} - ---- diff --git a/apis/v2/operations/get-itwin-user-members/displayName.md b/apis/v2/operations/get-itwin-user-members/displayName.md deleted file mode 100644 index cafd6bd..0000000 --- a/apis/v2/operations/get-itwin-user-members/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Get iTwin user members \ No newline at end of file diff --git a/apis/v2/operations/remove-itwin-group-member/description.md b/apis/v2/operations/remove-itwin-group-member/description.md deleted file mode 100644 index a0be90c..0000000 --- a/apis/v2/operations/remove-itwin-group-member/description.md +++ /dev/null @@ -1,9 +0,0 @@ ---- - -Remove the specified group member from the iTwin. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/remove-itwin-group-member/displayName.md b/apis/v2/operations/remove-itwin-group-member/displayName.md deleted file mode 100644 index b8dc5e9..0000000 --- a/apis/v2/operations/remove-itwin-group-member/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Remove iTwin group member \ No newline at end of file diff --git a/apis/v2/operations/remove-itwin-owner-member/description.md b/apis/v2/operations/remove-itwin-owner-member/description.md deleted file mode 100644 index 02810a6..0000000 --- a/apis/v2/operations/remove-itwin-owner-member/description.md +++ /dev/null @@ -1,11 +0,0 @@ ---- - -Remove the specified owner from the iTwin. - -{!Authorization.md!} - -You must be an owner to remove other owners. - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/remove-itwin-owner-member/displayName.md b/apis/v2/operations/remove-itwin-owner-member/displayName.md deleted file mode 100644 index a2988c9..0000000 --- a/apis/v2/operations/remove-itwin-owner-member/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Remove iTwin owner member \ No newline at end of file diff --git a/apis/v2/operations/remove-itwin-user-member/description.md b/apis/v2/operations/remove-itwin-user-member/description.md deleted file mode 100644 index 6009286..0000000 --- a/apis/v2/operations/remove-itwin-user-member/description.md +++ /dev/null @@ -1,9 +0,0 @@ ---- - -Remove the specified user member from the iTwin. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/remove-itwin-user-member/displayName.md b/apis/v2/operations/remove-itwin-user-member/displayName.md deleted file mode 100644 index bb8769f..0000000 --- a/apis/v2/operations/remove-itwin-user-member/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Remove iTwin user member \ No newline at end of file diff --git a/apis/v2/operations/update-iTwin-role/description.md b/apis/v2/operations/update-iTwin-role/description.md deleted file mode 100644 index d2b7b60..0000000 --- a/apis/v2/operations/update-iTwin-role/description.md +++ /dev/null @@ -1,9 +0,0 @@ ---- - -Update the specified iTwin role. - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/update-iTwin-role/displayName.md b/apis/v2/operations/update-iTwin-role/displayName.md deleted file mode 100644 index 8eae21f..0000000 --- a/apis/v2/operations/update-iTwin-role/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Update iTwin role \ No newline at end of file diff --git a/apis/v2/operations/update-itwin-group-member/description.md b/apis/v2/operations/update-itwin-group-member/description.md deleted file mode 100644 index 3ec5c7f..0000000 --- a/apis/v2/operations/update-itwin-group-member/description.md +++ /dev/null @@ -1,9 +0,0 @@ ---- - -Update an iTwin group member's role assignments - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/update-itwin-group-member/displayName.md b/apis/v2/operations/update-itwin-group-member/displayName.md deleted file mode 100644 index 7ffc336..0000000 --- a/apis/v2/operations/update-itwin-group-member/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Update iTwin group member \ No newline at end of file diff --git a/apis/v2/operations/update-itwin-group/description.md b/apis/v2/operations/update-itwin-group/description.md deleted file mode 100644 index d021b08..0000000 --- a/apis/v2/operations/update-itwin-group/description.md +++ /dev/null @@ -1,17 +0,0 @@ ---- - -Update the specified iTwin group. The `members` and `imsGroups` properties are both capped at 50 each. - -{!Authorization.md!} - -### Authorization - -A user can update a Group by being assigned the `administration_manage_groups` on the iTwin level. If the user is adding members or IMS groups they must also have the `administration_invite_member` permission assigned at the iTwin level. If the user is removing members or IMS groups they must also have the `administration_remove_member` permission assigned at the iTwin level. - -A user also can update a Group on an iTwin by either being an Organization Administrator for the Organization that owns the given iTwin, or an owner of the iTwin. - -To update a Group on the Account iTwin, the user must be an Organization Administrator for the Organization. - -An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page - ---- diff --git a/apis/v2/operations/update-itwin-group/displayName.md b/apis/v2/operations/update-itwin-group/displayName.md deleted file mode 100644 index 337cbad..0000000 --- a/apis/v2/operations/update-itwin-group/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Update iTwin group \ No newline at end of file diff --git a/apis/v2/operations/update-itwin-user-member/description.md b/apis/v2/operations/update-itwin-user-member/description.md deleted file mode 100644 index e7e6f8e..0000000 --- a/apis/v2/operations/update-itwin-user-member/description.md +++ /dev/null @@ -1,9 +0,0 @@ ---- - -Update an iTwin user member's role assignments - -{!Authorization.md!} - -{!iTwinsRBACPermission.md!} - ---- diff --git a/apis/v2/operations/update-itwin-user-member/displayName.md b/apis/v2/operations/update-itwin-user-member/displayName.md deleted file mode 100644 index 9bee9bb..0000000 --- a/apis/v2/operations/update-itwin-user-member/displayName.md +++ /dev/null @@ -1 +0,0 @@ -Update iTwin user member \ No newline at end of file From c47f8b4fc639c628f2021fef4c8413b25ec8ffa9 Mon Sep 17 00:00:00 2001 From: Linas B Date: Thu, 5 Sep 2024 15:45:44 +0300 Subject: [PATCH 5/5] Removed trailing lines --- apis/access-control/v2/apiName.md | 2 +- apis/access-control/v2/title.md | 2 +- apis/carbon-calculation/v1/apiName.md | 2 +- apis/carbon-calculation/v1/title.md | 2 +- apis/changed-elements/v2/apiName.md | 2 +- apis/changed-elements/v2/title.md | 2 +- apis/clash-detection/v2/apiName.md | 2 +- apis/clash-detection/v2/title.md | 2 +- apis/contextcapture/v1/apiName.md | 2 +- apis/contextcapture/v1/title.md | 2 +- apis/echo/v2/apiName.md | 2 +- apis/echo/v2/title.md | 2 +- apis/export/v1/apiName.md | 2 +- apis/export/v1/title.md | 2 +- apis/extensions/v1/apiName.md | 2 +- apis/extensions/v1/title.md | 2 +- apis/forms/v1/apiName.md | 2 +- apis/forms/v1/title.md | 2 +- apis/grouping-and-mapping/v1/apiName.md | 2 +- apis/grouping-and-mapping/v1/title.md | 2 +- apis/imodel-rpc/v1/apiName.md | 2 +- apis/imodel-rpc/v1/title.md | 2 +- apis/imodels-odata/v1/apiName.md | 2 +- apis/imodels-odata/v1/title.md | 2 +- apis/imodels/v2/apiName.md | 2 +- apis/imodels/v2/title.md | 2 +- apis/issues/v1/apiName.md | 2 +- apis/issues/v1/title.md | 2 +- apis/itwin-entities/v1/apiName.md | 2 +- apis/itwin-entities/v1/title.md | 2 +- apis/itwin-search/v1/apiName.md | 2 +- apis/itwin-search/v1/title.md | 2 +- apis/itwins/v1/apiName.md | 2 +- apis/itwins/v1/title.md | 2 +- apis/library/v1/apiName.md | 2 +- apis/library/v1/title.md | 2 +- apis/mesh-export/v1/apiName.md | 2 +- apis/mesh-export/v1/title.md | 2 +- apis/named-groups/v1/apiName.md | 2 +- apis/named-groups/v1/title.md | 2 +- apis/pnid-to-itwin/v2/apiName.md | 2 +- apis/pnid-to-itwin/v2/title.md | 2 +- apis/projects/v1/apiName.md | 2 +- apis/projects/v1/title.md | 2 +- apis/projectwise365-insights/v1/apiName.md | 2 +- apis/projectwise365-insights/v1/title.md | 2 +- apis/reality-data/v1/apiName.md | 2 +- apis/reality-data/v1/title.md | 2 +- apis/reality-management/v1/apiName.md | 2 +- apis/reality-management/v1/title.md | 2 +- apis/realityconversion/v1/apiName.md | 2 +- apis/realityconversion/v1/title.md | 2 +- apis/realitydataanalysis/v1/apiName.md | 2 +- apis/realitydataanalysis/v1/title.md | 2 +- apis/reporting/v2/apiName.md | 2 +- apis/reporting/v2/title.md | 2 +- apis/savedviews/v1/apiName.md | 2 +- apis/savedviews/v1/title.md | 2 +- apis/sensor-data-websocket/v1/apiName.md | 2 +- apis/sensor-data-websocket/v1/title.md | 2 +- apis/sensor-data/v1/apiName.md | 2 +- apis/sensor-data/v1/title.md | 2 +- apis/storage-container/v1/apiName.md | 2 +- apis/storage-container/v1/title.md | 2 +- apis/storage/v1/apiName.md | 2 +- apis/storage/v1/title.md | 2 +- apis/synchronization/v1/apiName.md | 2 +- apis/synchronization/v1/title.md | 2 +- apis/transformations/v1/apiName.md | 2 +- apis/transformations/v1/title.md | 2 +- apis/users/v1/apiName.md | 2 +- apis/users/v1/title.md | 2 +- apis/validation/v1/apiName.md | 2 +- apis/validation/v1/title.md | 2 +- apis/webhooks/v2/apiName.md | 2 +- apis/webhooks/v2/title.md | 2 +- 76 files changed, 76 insertions(+), 76 deletions(-) diff --git a/apis/access-control/v2/apiName.md b/apis/access-control/v2/apiName.md index fd50196..c37b6ec 100644 --- a/apis/access-control/v2/apiName.md +++ b/apis/access-control/v2/apiName.md @@ -1 +1 @@ -access-control-v2 +access-control-v2 \ No newline at end of file diff --git a/apis/access-control/v2/title.md b/apis/access-control/v2/title.md index d9cfe0b..e9688dd 100644 --- a/apis/access-control/v2/title.md +++ b/apis/access-control/v2/title.md @@ -1 +1 @@ -Access Control +Access Control \ No newline at end of file diff --git a/apis/carbon-calculation/v1/apiName.md b/apis/carbon-calculation/v1/apiName.md index 0092bd5..0d17fb2 100644 --- a/apis/carbon-calculation/v1/apiName.md +++ b/apis/carbon-calculation/v1/apiName.md @@ -1 +1 @@ -carbon-calculation +carbon-calculation \ No newline at end of file diff --git a/apis/carbon-calculation/v1/title.md b/apis/carbon-calculation/v1/title.md index d98aa84..41b4e13 100644 --- a/apis/carbon-calculation/v1/title.md +++ b/apis/carbon-calculation/v1/title.md @@ -1 +1 @@ -Carbon Calculation +Carbon Calculation \ No newline at end of file diff --git a/apis/changed-elements/v2/apiName.md b/apis/changed-elements/v2/apiName.md index ee59ebf..f82b8fd 100644 --- a/apis/changed-elements/v2/apiName.md +++ b/apis/changed-elements/v2/apiName.md @@ -1 +1 @@ -changed-elements-v2 +changed-elements-v2 \ No newline at end of file diff --git a/apis/changed-elements/v2/title.md b/apis/changed-elements/v2/title.md index 7bb55c5..ca724b8 100644 --- a/apis/changed-elements/v2/title.md +++ b/apis/changed-elements/v2/title.md @@ -1 +1 @@ -Changed Elements +Changed Elements \ No newline at end of file diff --git a/apis/clash-detection/v2/apiName.md b/apis/clash-detection/v2/apiName.md index 02b4f32..10c2567 100644 --- a/apis/clash-detection/v2/apiName.md +++ b/apis/clash-detection/v2/apiName.md @@ -1 +1 @@ -clash-detection-v2 +clash-detection-v2 \ No newline at end of file diff --git a/apis/clash-detection/v2/title.md b/apis/clash-detection/v2/title.md index 0bb857b..665d1b2 100644 --- a/apis/clash-detection/v2/title.md +++ b/apis/clash-detection/v2/title.md @@ -1 +1 @@ -Clash Detection +Clash Detection \ No newline at end of file diff --git a/apis/contextcapture/v1/apiName.md b/apis/contextcapture/v1/apiName.md index 88b620e..56bbafe 100644 --- a/apis/contextcapture/v1/apiName.md +++ b/apis/contextcapture/v1/apiName.md @@ -1 +1 @@ -contextcapture +contextcapture \ No newline at end of file diff --git a/apis/contextcapture/v1/title.md b/apis/contextcapture/v1/title.md index 30d2ae7..5314fe6 100644 --- a/apis/contextcapture/v1/title.md +++ b/apis/contextcapture/v1/title.md @@ -1 +1 @@ -Reality Modeling +Reality Modeling \ No newline at end of file diff --git a/apis/echo/v2/apiName.md b/apis/echo/v2/apiName.md index ae241a8..5e3b44c 100644 --- a/apis/echo/v2/apiName.md +++ b/apis/echo/v2/apiName.md @@ -1 +1 @@ -echo-v2 +echo-v2 \ No newline at end of file diff --git a/apis/echo/v2/title.md b/apis/echo/v2/title.md index 3236536..b9fe5c3 100644 --- a/apis/echo/v2/title.md +++ b/apis/echo/v2/title.md @@ -1 +1 @@ -Echo Context API +Echo Context API \ No newline at end of file diff --git a/apis/export/v1/apiName.md b/apis/export/v1/apiName.md index d563759..1f5d640 100644 --- a/apis/export/v1/apiName.md +++ b/apis/export/v1/apiName.md @@ -1 +1 @@ -export +export \ No newline at end of file diff --git a/apis/export/v1/title.md b/apis/export/v1/title.md index ceef4a5..d1ba7f9 100644 --- a/apis/export/v1/title.md +++ b/apis/export/v1/title.md @@ -1 +1 @@ -Export +Export \ No newline at end of file diff --git a/apis/extensions/v1/apiName.md b/apis/extensions/v1/apiName.md index f427429..ede5d71 100644 --- a/apis/extensions/v1/apiName.md +++ b/apis/extensions/v1/apiName.md @@ -1 +1 @@ -extensions +extensions \ No newline at end of file diff --git a/apis/extensions/v1/title.md b/apis/extensions/v1/title.md index 3c505fe..571e32f 100644 --- a/apis/extensions/v1/title.md +++ b/apis/extensions/v1/title.md @@ -1 +1 @@ -iTwin.js Extensions +iTwin.js Extensions \ No newline at end of file diff --git a/apis/forms/v1/apiName.md b/apis/forms/v1/apiName.md index b002f20..59c7fe0 100644 --- a/apis/forms/v1/apiName.md +++ b/apis/forms/v1/apiName.md @@ -1 +1 @@ -forms +forms \ No newline at end of file diff --git a/apis/forms/v1/title.md b/apis/forms/v1/title.md index b5ba36f..384ec35 100644 --- a/apis/forms/v1/title.md +++ b/apis/forms/v1/title.md @@ -1 +1 @@ -Forms +Forms \ No newline at end of file diff --git a/apis/grouping-and-mapping/v1/apiName.md b/apis/grouping-and-mapping/v1/apiName.md index 4612f67..797ae62 100644 --- a/apis/grouping-and-mapping/v1/apiName.md +++ b/apis/grouping-and-mapping/v1/apiName.md @@ -1 +1 @@ -grouping-and-mapping +grouping-and-mapping \ No newline at end of file diff --git a/apis/grouping-and-mapping/v1/title.md b/apis/grouping-and-mapping/v1/title.md index b788897..c6225b9 100644 --- a/apis/grouping-and-mapping/v1/title.md +++ b/apis/grouping-and-mapping/v1/title.md @@ -1 +1 @@ -Grouping and Mapping +Grouping and Mapping \ No newline at end of file diff --git a/apis/imodel-rpc/v1/apiName.md b/apis/imodel-rpc/v1/apiName.md index 1ed47b9..146c9db 100644 --- a/apis/imodel-rpc/v1/apiName.md +++ b/apis/imodel-rpc/v1/apiName.md @@ -1 +1 @@ -imodel-rpc +imodel-rpc \ No newline at end of file diff --git a/apis/imodel-rpc/v1/title.md b/apis/imodel-rpc/v1/title.md index 133638a..5a06ea0 100644 --- a/apis/imodel-rpc/v1/title.md +++ b/apis/imodel-rpc/v1/title.md @@ -1 +1 @@ -iModel RPC +iModel RPC \ No newline at end of file diff --git a/apis/imodels-odata/v1/apiName.md b/apis/imodels-odata/v1/apiName.md index 4edb4cc..8ed6f76 100644 --- a/apis/imodels-odata/v1/apiName.md +++ b/apis/imodels-odata/v1/apiName.md @@ -1 +1 @@ -imodels-odata +imodels-odata \ No newline at end of file diff --git a/apis/imodels-odata/v1/title.md b/apis/imodels-odata/v1/title.md index 4de2337..6c9c997 100644 --- a/apis/imodels-odata/v1/title.md +++ b/apis/imodels-odata/v1/title.md @@ -1 +1 @@ -iModels OData +iModels OData \ No newline at end of file diff --git a/apis/imodels/v2/apiName.md b/apis/imodels/v2/apiName.md index ea0e7f8..9906266 100644 --- a/apis/imodels/v2/apiName.md +++ b/apis/imodels/v2/apiName.md @@ -1 +1 @@ -imodels-v2 +imodels-v2 \ No newline at end of file diff --git a/apis/imodels/v2/title.md b/apis/imodels/v2/title.md index 1d0c668..a0ca5e4 100644 --- a/apis/imodels/v2/title.md +++ b/apis/imodels/v2/title.md @@ -1 +1 @@ -iModels +iModels \ No newline at end of file diff --git a/apis/issues/v1/apiName.md b/apis/issues/v1/apiName.md index d0fe088..41f084e 100644 --- a/apis/issues/v1/apiName.md +++ b/apis/issues/v1/apiName.md @@ -1 +1 @@ -issues-v1 +issues-v1 \ No newline at end of file diff --git a/apis/issues/v1/title.md b/apis/issues/v1/title.md index f99478d..b502938 100644 --- a/apis/issues/v1/title.md +++ b/apis/issues/v1/title.md @@ -1 +1 @@ -Issues +Issues \ No newline at end of file diff --git a/apis/itwin-entities/v1/apiName.md b/apis/itwin-entities/v1/apiName.md index 8d440dc..00bb26c 100644 --- a/apis/itwin-entities/v1/apiName.md +++ b/apis/itwin-entities/v1/apiName.md @@ -1 +1 @@ -itwin-entities +itwin-entities \ No newline at end of file diff --git a/apis/itwin-entities/v1/title.md b/apis/itwin-entities/v1/title.md index 91b48c4..ef7efca 100644 --- a/apis/itwin-entities/v1/title.md +++ b/apis/itwin-entities/v1/title.md @@ -1 +1 @@ -iTwin Entities +iTwin Entities \ No newline at end of file diff --git a/apis/itwin-search/v1/apiName.md b/apis/itwin-search/v1/apiName.md index 988161a..2c6d0a5 100644 --- a/apis/itwin-search/v1/apiName.md +++ b/apis/itwin-search/v1/apiName.md @@ -1 +1 @@ -itwin-search +itwin-search \ No newline at end of file diff --git a/apis/itwin-search/v1/title.md b/apis/itwin-search/v1/title.md index b7f8197..e87df10 100644 --- a/apis/itwin-search/v1/title.md +++ b/apis/itwin-search/v1/title.md @@ -1 +1 @@ -iTwin Search +iTwin Search \ No newline at end of file diff --git a/apis/itwins/v1/apiName.md b/apis/itwins/v1/apiName.md index c0af2cf..b4f9314 100644 --- a/apis/itwins/v1/apiName.md +++ b/apis/itwins/v1/apiName.md @@ -1 +1 @@ -itwins +itwins \ No newline at end of file diff --git a/apis/itwins/v1/title.md b/apis/itwins/v1/title.md index e279631..870a132 100644 --- a/apis/itwins/v1/title.md +++ b/apis/itwins/v1/title.md @@ -1 +1 @@ -iTwins +iTwins \ No newline at end of file diff --git a/apis/library/v1/apiName.md b/apis/library/v1/apiName.md index 14d6358..90ad192 100644 --- a/apis/library/v1/apiName.md +++ b/apis/library/v1/apiName.md @@ -1 +1 @@ -library +library \ No newline at end of file diff --git a/apis/library/v1/title.md b/apis/library/v1/title.md index 7728246..729bdde 100644 --- a/apis/library/v1/title.md +++ b/apis/library/v1/title.md @@ -1 +1 @@ -Library +Library \ No newline at end of file diff --git a/apis/mesh-export/v1/apiName.md b/apis/mesh-export/v1/apiName.md index 1140550..5d582dd 100644 --- a/apis/mesh-export/v1/apiName.md +++ b/apis/mesh-export/v1/apiName.md @@ -1 +1 @@ -mesh-export +mesh-export \ No newline at end of file diff --git a/apis/mesh-export/v1/title.md b/apis/mesh-export/v1/title.md index e8ffca6..6e0e22d 100644 --- a/apis/mesh-export/v1/title.md +++ b/apis/mesh-export/v1/title.md @@ -1 +1 @@ -Mesh Export +Mesh Export \ No newline at end of file diff --git a/apis/named-groups/v1/apiName.md b/apis/named-groups/v1/apiName.md index 22684fd..333c4e8 100644 --- a/apis/named-groups/v1/apiName.md +++ b/apis/named-groups/v1/apiName.md @@ -1 +1 @@ -named-groups +named-groups \ No newline at end of file diff --git a/apis/named-groups/v1/title.md b/apis/named-groups/v1/title.md index 4844570..8c038a5 100644 --- a/apis/named-groups/v1/title.md +++ b/apis/named-groups/v1/title.md @@ -1 +1 @@ -Named Groups +Named Groups \ No newline at end of file diff --git a/apis/pnid-to-itwin/v2/apiName.md b/apis/pnid-to-itwin/v2/apiName.md index d2fe437..9c2da04 100644 --- a/apis/pnid-to-itwin/v2/apiName.md +++ b/apis/pnid-to-itwin/v2/apiName.md @@ -1 +1 @@ -pnid-to-itwin-v2 +pnid-to-itwin-v2 \ No newline at end of file diff --git a/apis/pnid-to-itwin/v2/title.md b/apis/pnid-to-itwin/v2/title.md index 9cf0c0e..c2a0ada 100644 --- a/apis/pnid-to-itwin/v2/title.md +++ b/apis/pnid-to-itwin/v2/title.md @@ -1 +1 @@ -PnID to iTwin +PnID to iTwin \ No newline at end of file diff --git a/apis/projects/v1/apiName.md b/apis/projects/v1/apiName.md index 7201f8c..495ef3b 100644 --- a/apis/projects/v1/apiName.md +++ b/apis/projects/v1/apiName.md @@ -1 +1 @@ -projects +projects \ No newline at end of file diff --git a/apis/projects/v1/title.md b/apis/projects/v1/title.md index c07db15..0577545 100644 --- a/apis/projects/v1/title.md +++ b/apis/projects/v1/title.md @@ -1 +1 @@ -Projects +Projects \ No newline at end of file diff --git a/apis/projectwise365-insights/v1/apiName.md b/apis/projectwise365-insights/v1/apiName.md index d8d601d..8bb8838 100644 --- a/apis/projectwise365-insights/v1/apiName.md +++ b/apis/projectwise365-insights/v1/apiName.md @@ -1 +1 @@ -projectwise365-insights +projectwise365-insights \ No newline at end of file diff --git a/apis/projectwise365-insights/v1/title.md b/apis/projectwise365-insights/v1/title.md index 7150ff5..24599b8 100644 --- a/apis/projectwise365-insights/v1/title.md +++ b/apis/projectwise365-insights/v1/title.md @@ -1 +1 @@ -ProjectWise 365 Insights +ProjectWise 365 Insights \ No newline at end of file diff --git a/apis/reality-data/v1/apiName.md b/apis/reality-data/v1/apiName.md index babff78..de951c0 100644 --- a/apis/reality-data/v1/apiName.md +++ b/apis/reality-data/v1/apiName.md @@ -1 +1 @@ -reality-data +reality-data \ No newline at end of file diff --git a/apis/reality-data/v1/title.md b/apis/reality-data/v1/title.md index 1034916..00a9651 100644 --- a/apis/reality-data/v1/title.md +++ b/apis/reality-data/v1/title.md @@ -1 +1 @@ -Reality Data +Reality Data \ No newline at end of file diff --git a/apis/reality-management/v1/apiName.md b/apis/reality-management/v1/apiName.md index 73e815e..3ecfe44 100644 --- a/apis/reality-management/v1/apiName.md +++ b/apis/reality-management/v1/apiName.md @@ -1 +1 @@ -reality-management +reality-management \ No newline at end of file diff --git a/apis/reality-management/v1/title.md b/apis/reality-management/v1/title.md index 5a27743..f57bf3b 100644 --- a/apis/reality-management/v1/title.md +++ b/apis/reality-management/v1/title.md @@ -1 +1 @@ -Reality Management +Reality Management \ No newline at end of file diff --git a/apis/realityconversion/v1/apiName.md b/apis/realityconversion/v1/apiName.md index 163742a..ea11fb0 100644 --- a/apis/realityconversion/v1/apiName.md +++ b/apis/realityconversion/v1/apiName.md @@ -1 +1 @@ -realityconversion +realityconversion \ No newline at end of file diff --git a/apis/realityconversion/v1/title.md b/apis/realityconversion/v1/title.md index be9d6d2..5abc2ab 100644 --- a/apis/realityconversion/v1/title.md +++ b/apis/realityconversion/v1/title.md @@ -1 +1 @@ -Reality Conversion +Reality Conversion \ No newline at end of file diff --git a/apis/realitydataanalysis/v1/apiName.md b/apis/realitydataanalysis/v1/apiName.md index 6f40dfe..41f0283 100644 --- a/apis/realitydataanalysis/v1/apiName.md +++ b/apis/realitydataanalysis/v1/apiName.md @@ -1 +1 @@ -realitydataanalysis +realitydataanalysis \ No newline at end of file diff --git a/apis/realitydataanalysis/v1/title.md b/apis/realitydataanalysis/v1/title.md index de74db0..1820476 100644 --- a/apis/realitydataanalysis/v1/title.md +++ b/apis/realitydataanalysis/v1/title.md @@ -1 +1 @@ -Reality Analysis +Reality Analysis \ No newline at end of file diff --git a/apis/reporting/v2/apiName.md b/apis/reporting/v2/apiName.md index de4207b..99b3178 100644 --- a/apis/reporting/v2/apiName.md +++ b/apis/reporting/v2/apiName.md @@ -1 +1 @@ -insights-v2 +insights-v2 \ No newline at end of file diff --git a/apis/reporting/v2/title.md b/apis/reporting/v2/title.md index c889573..a692c3f 100644 --- a/apis/reporting/v2/title.md +++ b/apis/reporting/v2/title.md @@ -1 +1 @@ -Reporting +Reporting \ No newline at end of file diff --git a/apis/savedviews/v1/apiName.md b/apis/savedviews/v1/apiName.md index 46f73df..310f907 100644 --- a/apis/savedviews/v1/apiName.md +++ b/apis/savedviews/v1/apiName.md @@ -1 +1 @@ -savedviews +savedviews \ No newline at end of file diff --git a/apis/savedviews/v1/title.md b/apis/savedviews/v1/title.md index cba43de..d4ebbee 100644 --- a/apis/savedviews/v1/title.md +++ b/apis/savedviews/v1/title.md @@ -1 +1 @@ -Saved Views +Saved Views \ No newline at end of file diff --git a/apis/sensor-data-websocket/v1/apiName.md b/apis/sensor-data-websocket/v1/apiName.md index 8d03623..b2d32b4 100644 --- a/apis/sensor-data-websocket/v1/apiName.md +++ b/apis/sensor-data-websocket/v1/apiName.md @@ -1 +1 @@ -sensor-data-websocket +sensor-data-websocket \ No newline at end of file diff --git a/apis/sensor-data-websocket/v1/title.md b/apis/sensor-data-websocket/v1/title.md index 6af0e5d..e91547b 100644 --- a/apis/sensor-data-websocket/v1/title.md +++ b/apis/sensor-data-websocket/v1/title.md @@ -1 +1 @@ -Sensor Data WebSocket +Sensor Data WebSocket \ No newline at end of file diff --git a/apis/sensor-data/v1/apiName.md b/apis/sensor-data/v1/apiName.md index e6959c4..4ab09fa 100644 --- a/apis/sensor-data/v1/apiName.md +++ b/apis/sensor-data/v1/apiName.md @@ -1 +1 @@ -sensor-data +sensor-data \ No newline at end of file diff --git a/apis/sensor-data/v1/title.md b/apis/sensor-data/v1/title.md index 79dd0a5..6c04cd5 100644 --- a/apis/sensor-data/v1/title.md +++ b/apis/sensor-data/v1/title.md @@ -1 +1 @@ -Sensor Data +Sensor Data \ No newline at end of file diff --git a/apis/storage-container/v1/apiName.md b/apis/storage-container/v1/apiName.md index 77689ff..6a1983d 100644 --- a/apis/storage-container/v1/apiName.md +++ b/apis/storage-container/v1/apiName.md @@ -1 +1 @@ -storage-container +storage-container \ No newline at end of file diff --git a/apis/storage-container/v1/title.md b/apis/storage-container/v1/title.md index 0d0e29f..7df1000 100644 --- a/apis/storage-container/v1/title.md +++ b/apis/storage-container/v1/title.md @@ -1 +1 @@ -Storage Container +Storage Container \ No newline at end of file diff --git a/apis/storage/v1/apiName.md b/apis/storage/v1/apiName.md index fa780e2..5d252d7 100644 --- a/apis/storage/v1/apiName.md +++ b/apis/storage/v1/apiName.md @@ -1 +1 @@ -storage +storage \ No newline at end of file diff --git a/apis/storage/v1/title.md b/apis/storage/v1/title.md index f12faf5..e5a8767 100644 --- a/apis/storage/v1/title.md +++ b/apis/storage/v1/title.md @@ -1 +1 @@ -Storage +Storage \ No newline at end of file diff --git a/apis/synchronization/v1/apiName.md b/apis/synchronization/v1/apiName.md index 3abca95..c170410 100644 --- a/apis/synchronization/v1/apiName.md +++ b/apis/synchronization/v1/apiName.md @@ -1 +1 @@ -synchronization +synchronization \ No newline at end of file diff --git a/apis/synchronization/v1/title.md b/apis/synchronization/v1/title.md index 368bfcd..af815b2 100644 --- a/apis/synchronization/v1/title.md +++ b/apis/synchronization/v1/title.md @@ -1 +1 @@ -Synchronization +Synchronization \ No newline at end of file diff --git a/apis/transformations/v1/apiName.md b/apis/transformations/v1/apiName.md index a6d3c52..7cfc1c0 100644 --- a/apis/transformations/v1/apiName.md +++ b/apis/transformations/v1/apiName.md @@ -1 +1 @@ -transformations +transformations \ No newline at end of file diff --git a/apis/transformations/v1/title.md b/apis/transformations/v1/title.md index 0faf38c..f3027da 100644 --- a/apis/transformations/v1/title.md +++ b/apis/transformations/v1/title.md @@ -1 +1 @@ -Transformations +Transformations \ No newline at end of file diff --git a/apis/users/v1/apiName.md b/apis/users/v1/apiName.md index ae22583..5347237 100644 --- a/apis/users/v1/apiName.md +++ b/apis/users/v1/apiName.md @@ -1 +1 @@ -users +users \ No newline at end of file diff --git a/apis/users/v1/title.md b/apis/users/v1/title.md index f3d929a..9402e21 100644 --- a/apis/users/v1/title.md +++ b/apis/users/v1/title.md @@ -1 +1 @@ -Users +Users \ No newline at end of file diff --git a/apis/validation/v1/apiName.md b/apis/validation/v1/apiName.md index d45b2de..efc0216 100644 --- a/apis/validation/v1/apiName.md +++ b/apis/validation/v1/apiName.md @@ -1 +1 @@ -validation +validation \ No newline at end of file diff --git a/apis/validation/v1/title.md b/apis/validation/v1/title.md index 5505e5b..ca61374 100644 --- a/apis/validation/v1/title.md +++ b/apis/validation/v1/title.md @@ -1 +1 @@ -Property Validation +Property Validation \ No newline at end of file diff --git a/apis/webhooks/v2/apiName.md b/apis/webhooks/v2/apiName.md index 7797b68..0be0b9c 100644 --- a/apis/webhooks/v2/apiName.md +++ b/apis/webhooks/v2/apiName.md @@ -1 +1 @@ -webhooks-v2 +webhooks-v2 \ No newline at end of file diff --git a/apis/webhooks/v2/title.md b/apis/webhooks/v2/title.md index d222512..b6a42a4 100644 --- a/apis/webhooks/v2/title.md +++ b/apis/webhooks/v2/title.md @@ -1 +1 @@ -Webhooks +Webhooks \ No newline at end of file