Skip to content

Commit 1b55085

Browse files
author
zhe_mstr
committed
Update
1 parent ee028d5 commit 1b55085

File tree

261 files changed

+526
-515
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

261 files changed

+526
-515
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
- [Open a pull request](#open-a-pull-request)
1111
- [Submit your PR & get it reviewed](#submit-your-pr--get-it-reviewed)
1212
- [Your PR is merged](#your-pr-is-merged)
13-
- [Keep contributing as you use MicroStrategy Docs](#keep-contributing-as-you-use-microstrategy-docs)
13+
- [Keep contributing as you use Strategy Docs](#keep-contributing-as-you-use-strategy-docs)
1414

1515
## Getting started
1616

@@ -44,7 +44,7 @@ Fork using GitHub Desktop:
4444

4545
### Make your update
4646

47-
Make your changes to the file(s) you'd like to update. Here are some tips and tricks for [using the docs codebase](#working-in-the-microstrategyrest-api-docs-repository).
47+
Make your changes to the file(s) you'd like to update. Here are some tips and tricks for [using the docs codebase](#working-in-the-strategyrest-api-docs-repository).
4848

4949
- Are you making changes to the application code? You'll need **Node.js v16** to run the site locally. See [contributing/development.md](contributing/development.md).
5050
- Are you contributing to markdown? We use [Markdown](https://www.markdownguide.org/basic-syntax/).
@@ -60,13 +60,13 @@ When you're done making changes and you'd like to propose them for review, use t
6060

6161
### Your PR is merged
6262

63-
Congratulations! The whole MicroStrategy community thanks you. :sparkles:
63+
Congratulations! The whole Strategy community thanks you. :sparkles:
6464

6565
Once your PR is merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/MicroStrategy/rest-api-docs/graphs/contributors) and at the bottom of the page you contributed to.
6666

67-
### Keep contributing as you use MicroStrategy Docs
67+
### Keep contributing as you use Strategy Docs
6868

69-
Now that you're a part of the MicroStrategy Docs community, you can keep participating in many ways.
69+
Now that you're a part of the Strategy Docs community, you can keep participating in many ways.
7070

7171
**Learn more about contributing:**
7272

@@ -77,7 +77,7 @@ Now that you're a part of the MicroStrategy Docs community, you can keep partici
7777
- [:earth_asia: Translations](#earth_asia-translations)
7878
- [Starting with an issue](#starting-with-an-issue)
7979
- [Opening a pull request](#opening-a-pull-request)
80-
- [Working in the MicroStrategy/rest-api-docs repository](#working-in-the-microstrategyrest-api-docs-repository)
80+
- [Working in the Strategy/rest-api-docs repository](#working-in-the-strategyrest-api-docs-repository)
8181
- [Reviewing](#reviewing)
8282
- [Self review](#self-review)
8383
- [Test it locally](#test-it-locally)
@@ -87,7 +87,7 @@ Now that you're a part of the MicroStrategy Docs community, you can keep partici
8787

8888
## :memo: Types of contributions
8989

90-
You can contribute to the REST API Docs content and site in several ways. This repo is a place to discuss and collaborate on MicroStrategy REST API Docs! Our small, but mighty :muscle: docs team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed.
90+
You can contribute to the REST API Docs content and site in several ways. This repo is a place to discuss and collaborate on Strategy REST API Docs! Our small, but mighty :muscle: docs team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed.
9191

9292
### :beetle: Issues
9393

@@ -101,7 +101,7 @@ When we merge those changes, they should be deployed to the live site within 24
101101

102102
### :question: Support
103103

104-
We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with MicroStrategy, unrelated to our documentation, please [contact MicroStrategy Support directly](https://www.microstrategy.com/support). Any issues, or pull requests opened here requesting support will be given information about how to contact MicroStrategy Support, then closed and locked.
104+
We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with Strategy, unrelated to our documentation, please [contact Strategy Support directly](https://www.microstrategy.com/support). Any issues, or pull requests opened here requesting support will be given information about how to contact Strategy Support, then closed and locked.
105105

106106
### :earth_asia: Translations
107107

@@ -117,7 +117,7 @@ You can browse existing issues to find something that needs help!
117117

118118
You can use the GitHub user interface :pencil2: for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine.
119119

120-
## Working in the MicroStrategy/rest-api-docs repository
120+
## Working in the Strategy/rest-api-docs repository
121121

122122
Here's some information that might be helpful while working on a Docs PR:
123123

@@ -126,7 +126,7 @@ Here's some information that might be helpful while working on a Docs PR:
126126

127127
## Reviewing
128128

129-
We (usually the docs team, but sometimes MicroStrategy product managers, engineers, or supportocats too!) review every single PR. The purpose of reviews is to create the best content we can for people who use MicroStrategy.
129+
We (usually the docs team, but sometimes product managers, engineers, or supportocats too!) review every single PR. The purpose of reviews is to create the best content we can for people who use Strategy.
130130

131131
:yellow_heart: Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time.
132132

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ pull request. For more details about this process, please check out
6161

6262
#### And that's it
6363

64-
That's how you can get started easily as a member of the MicroStrategy Embedding SDK Documentation
64+
That's how you can get started easily as a member of the Strategy Embedding SDK Documentation
6565
community. :sparkles:
6666

6767
If you want to know more, or you're making a more complex contribution, check out

contributing/content-style-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ The list below shows the usage of emojis in our Docs site:
135135

136136
- Titles, sidebar labels, and headers
137137

138-
- These should use **sentence case**. For example, prefer "This is the title from MicroStrategy" over "This Is The Title From MicroStrategy".
138+
- These should use **sentence case**. For example, prefer "This is the title from Strategy" over "This Is The Title From Strategy".
139139
- `sidebar_label` should only be used if you want a different title in the sidebar than the `title` in front matter. (Note: For folders, `label` in sidebars.js takes priority over `sidebar_label`)
140140

141141
## Tables
@@ -209,7 +209,7 @@ For the root of a collection of workflows, please use the template below:
209209
210210
You can try these workflows with [REST API Playground]().
211211
212-
Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md).
212+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
213213
214214
:::
215215
```
@@ -221,7 +221,7 @@ For the workflow page, please use the template below:
221221
222222
You can try out this workflow at [REST API Playground]().
223223
224-
Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md).
224+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
225225
226226
:::
227227
```

docs/common-workflows/administration/datasource-management/add-and-remove-datasource-from-project.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ A detailed description of each step of this request is listed down below. For th
1414

1515
Endpoint: [GET /api/projects/\{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/getProjectDatasources)
1616

17-
This endpoint allows the caller to get the datasources associated with a specific project with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing the datasources for a project.
17+
This endpoint allows the caller to get the datasources associated with a specific project with the Strategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing the datasources for a project.
1818

1919
Sample Request
2020

@@ -114,13 +114,13 @@ Sample Response
114114

115115
You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2d0b3eac-9704-42a7-9481-fec12557b752?ctx=documentation).
116116

117-
Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md).
117+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
118118

119119
:::
120120

121121
Endpoint: [PATCH /api/projects/\{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateProjectDatasources)
122122

123-
This endpoint allows the caller to add and remove a datasource to a specific project with the MicroStrategy REST Server. In this request we will add a datasource. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. For this sample we will be adding the Act! Essentials datasource to the MicroStrategy Tutorial project. You can find the datasourceId using the endpoint `GET /api/datasources` and the projectId using `GET /api/projects`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the project's datasources.
123+
This endpoint allows the caller to add and remove a datasource to a specific project with the Strategy REST Server. In this request we will add a datasource. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. For this sample we will be adding the Act! Essentials datasource to the MicroStrategy Tutorial project. You can find the datasourceId using the endpoint `GET /api/datasources` and the projectId using `GET /api/projects`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the project's datasources.
124124

125125
Sample Request
126126

@@ -242,13 +242,13 @@ Sample Response Code: 200 (Add datasource to project.)
242242

243243
You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-577baae8-f1b6-4ed2-8819-bc3aed5ec5c7?ctx=documentation).
244244

245-
Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md).
245+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
246246

247247
:::
248248

249249
Endpoint: [PATCH /api/projects/\{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateProjectDatasources)
250250

251-
This endpoint allows the caller to add and remove a datasource to a specific project with the MicroStrategy REST Server. In this request we will remove a datasource. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. For this sample we will be removing the Act! Essentials datasource from the MicroStrategy Tutorial project. You can find the datasourceId using the endpoint `GET /api/datasources` and the projectId using `GET /api/projects`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the project's datasources.
251+
This endpoint allows the caller to add and remove a datasource to a specific project with the Strategy REST Server. In this request we will remove a datasource. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. For this sample we will be removing the Act! Essentials datasource from the MicroStrategy Tutorial project. You can find the datasourceId using the endpoint `GET /api/datasources` and the projectId using `GET /api/projects`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the project's datasources.
252252

253253
Sample Request
254254

docs/common-workflows/administration/datasource-management/convert-connection-string-from-dsn-to-dsnless-for-a-datasource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: This workflow sample demonstrates how to convert connection string
99

1010
You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-737e03ad-a41a-46d5-bf7a-00e68963b08b?ctx=documentation).
1111

12-
Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md).
12+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
1313

1414
:::
1515

docs/common-workflows/administration/datasource-management/datasource-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: You can use REST API requests to manage datasources.
77

88
You can try these workflows with [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-fe63e329-ca17-40e6-9263-8f451b95e06e?ctx=documentation).
99

10-
Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md).
10+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
1111

1212
:::
1313

docs/common-workflows/administration/datasource-management/delete-a-datasource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The workflow for deleting and cleaning up a datasource includes the following se
1313

1414
You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-2da893be-a6e9-449a-95ae-749b5906bb27?ctx=documentation).
1515

16-
Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md).
16+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
1717

1818
:::
1919

docs/common-workflows/administration/datasource-management/get-datasource-applicable-advanced-properties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: Get applicable properties for a datasource.
1010

1111
You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-585d42d1-fbdc-4d1d-afbb-c4e872753709?ctx=documentation).
1212

13-
Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md).
13+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
1414

1515
:::
1616

docs/common-workflows/administration/datasource-management/get-datasource-with-advanced-properties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: The workflow involves getting datasource definition along with its
99

1010
You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-c8ec1165-e5d3-4b9a-bc68-df3d71d493f7?ctx=documentation).
1111

12-
Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/playground.md).
12+
Learn more about Strategy REST API Playground [here](/docs/getting-started/playground.md).
1313

1414
:::
1515

docs/common-workflows/administration/datasource-management/update-a-datasource.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ A detailed description of each step of this request is listed down below.
1515

1616
Endpoint: [PATCH /api/datasources/\{datasourceId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasource)
1717

18-
This endpoint allows the caller to update a database source with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the datasourceId using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing a info for the updated database source.
18+
This endpoint allows the caller to update a database source with the Strategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the datasourceId using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing a info for the updated database source.
1919

2020
Sample Request
2121

@@ -100,7 +100,7 @@ Sample Response
100100

101101
Endpoint: [PATCH /api/datasources/connections/\{connectionId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasourceConnection)
102102

103-
This endpoint allows the caller to update a datasource connection with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the connectionId using the endpoint `GET /api/datasources/connections`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info for the updated datasource connection.
103+
This endpoint allows the caller to update a datasource connection with the Strategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the connectionId using the endpoint `GET /api/datasources/connections`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info for the updated datasource connection.
104104

105105
Sample Request
106106

@@ -183,7 +183,7 @@ Sample Response
183183

184184
Endpoint: [PATCH /api/datasources/logins/\{loginId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasourceLogin)
185185

186-
This endpoint allows the caller to update a datasource login with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the loginId using the endpoint `GET /api/datasources/logins`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info for the updated datasource login.
186+
This endpoint allows the caller to update a datasource login with the Strategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the loginId using the endpoint `GET /api/datasources/logins`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info for the updated datasource login.
187187

188188
Sample Request
189189

0 commit comments

Comments
 (0)