Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- [Open a pull request](#open-a-pull-request)
- [Submit your PR & get it reviewed](#submit-your-pr--get-it-reviewed)
- [Your PR is merged](#your-pr-is-merged)
- [Keep contributing as you use MicroStrategy Docs](#keep-contributing-as-you-use-microstrategy-docs)
- [Keep contributing as you use Strategy Docs](#keep-contributing-as-you-use-strategy-docs)

## Getting started

Expand Down Expand Up @@ -44,7 +44,7 @@ Fork using GitHub Desktop:

### Make your update

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).
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).

- 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).
- Are you contributing to markdown? We use [Markdown](https://www.markdownguide.org/basic-syntax/).
Expand All @@ -60,13 +60,13 @@ When you're done making changes and you'd like to propose them for review, use t

### Your PR is merged

Congratulations! The whole MicroStrategy community thanks you. :sparkles:
Congratulations! The whole Strategy community thanks you. :sparkles:

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.

### Keep contributing as you use MicroStrategy Docs
### Keep contributing as you use Strategy Docs

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

**Learn more about contributing:**

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

## :memo: Types of contributions

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.
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.

### :beetle: Issues

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

### :question: Support

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.
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.

### :earth_asia: Translations

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

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.

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

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

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

## Reviewing

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.
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.

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

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ pull request. For more details about this process, please check out

#### And that's it

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

If you want to know more, or you're making a more complex contribution, check out
Expand Down
6 changes: 3 additions & 3 deletions contributing/content-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ The list below shows the usage of emojis in our Docs site:

- Titles, sidebar labels, and headers

- These should use **sentence case**. For example, prefer "This is the title from MicroStrategy" over "This Is The Title From MicroStrategy".
- These should use **sentence case**. For example, prefer "This is the title from Strategy" over "This Is The Title From Strategy".
- `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`)

## Tables
Expand Down Expand Up @@ -209,7 +209,7 @@ For the root of a collection of workflows, please use the template below:

You can try these workflows with [REST API Playground]().

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

:::
```
Expand All @@ -221,7 +221,7 @@ For the workflow page, please use the template below:

You can try out this workflow at [REST API Playground]().

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

:::
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A detailed description of each step of this request is listed down below. For th

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

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.
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.

Sample Request

Expand Down Expand Up @@ -114,13 +114,13 @@ Sample Response

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).

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

:::

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

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.
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.

Sample Request

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

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).

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

:::

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

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.
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.

Sample Request

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: This workflow sample demonstrates how to convert connection string

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).

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

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: You can use REST API requests to manage datasources.

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).

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

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The workflow for deleting and cleaning up a datasource includes the following se

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).

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

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: Get applicable properties for a datasource.

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).

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

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: The workflow involves getting datasource definition along with its

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).

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

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A detailed description of each step of this request is listed down below.

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

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.
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.

Sample Request

Expand Down Expand Up @@ -100,7 +100,7 @@ Sample Response

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

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.
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.

Sample Request

Expand Down Expand Up @@ -183,7 +183,7 @@ Sample Response

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

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.
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.

Sample Request

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: The workflow involves modifying datasource's advanced properties va

You can try out this workflow at [REST API Playground](https://www.postman.com/microstrategysdk/workspace/microstrategy-rest-api/folder/16131298-689ad52e-2dee-4582-92a1-679dc0fda692?ctx=documentation).

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

:::

Expand Down
Loading