Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Update Creator Store Docs #889

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

yusufameri
Copy link
Contributor

Changes

Checks

By submitting your pull request for review, you agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

@yusufameri yusufameri requested a review from a team as a code owner October 25, 2024 23:41
@github-actions github-actions bot added the engine guides Changes the Engine guides label Oct 25, 2024
<td>categoryId (path)</td>
<td>int</td>
<td>
Audio = 3<br>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality check says: Expected a closing tag for <br> (67:23-67:27) before the end of paragraph

⛔️ This change is a requirement. Please fix it before merging.
🤖 The feedback in this comment is automated and might be incorrect.

> [!NOTE]
> We acknowledge that the toolbox-service API described below is not covered on the official Cloud APIs documentation. We are planning to better support Creator Store search with a cleaner API in future, stay tuned for updates.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Multiple consecutive blank lines (MD012/no-multiple-blanks)
  • Expected: 1; Actual: 2.

For more information, see the Markdownlint docs for MD012/no-multiple-blanks. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.

⛔️ This change is a requirement. Please fix it before merging.

Video = 62
FontFamily = 73
Music = 300


Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Multiple consecutive blank lines (MD012/no-multiple-blanks)
  • Expected: 1; Actual: 2.

For more information, see the Markdownlint docs for MD012/no-multiple-blanks. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.

⛔️ This change is a requirement. Please fix it before merging.


You can replace `[params]` with the appropriate [query parameters](#query-parameters) to customize your search.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Multiple consecutive blank lines (MD012/no-multiple-blanks)
  • Expected: 1; Actual: 3.

For more information, see the Markdownlint docs for MD012/no-multiple-blanks. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.

⛔️ This change is a requirement. Please fix it before merging.

</table>

The following URL will search for 10 items in the "Models" subcategory, sorted by most recently updated.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Multiple consecutive blank lines (MD012/no-multiple-blanks)
  • Expected: 1; Actual: 2.

For more information, see the Markdownlint docs for MD012/no-multiple-blanks. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.

⛔️ This change is a requirement. Please fix it before merging.

```json
### Response Fields


Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Multiple consecutive blank lines (MD012/no-multiple-blanks)
  • Expected: 1; Actual: 2.

For more information, see the Markdownlint docs for MD012/no-multiple-blanks. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.

⛔️ This change is a requirement. Please fix it before merging.

}
```


Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Multiple consecutive blank lines (MD012/no-multiple-blanks)
  • Expected: 1; Actual: 2.

For more information, see the Markdownlint docs for MD012/no-multiple-blanks. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.

⛔️ This change is a requirement. Please fix it before merging.


You can replace `[categoryId]` and `[params]` with the appropriate [query parameters](#query-parameters) to customize your search.

### CategoryId:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Trailing punctuation in heading (MD026/no-trailing-punctuation)
  • Punctuation: ':'.

For more information, see the Markdownlint docs for MD026/no-trailing-punctuation. You might be able to fix this by using markdownlint for VS Code or by running npm ci && npm run markdownlint.

⛔️ This change is a requirement. Please fix it before merging.


API responses return in a JSON format. The response provides asset details with the following primary fields:
```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Fenced code blocks should have a language specified (MD040/fenced-code-language)

For more information, see the Markdownlint docs for MD040/fenced-code-language.

⛔️ This change is a requirement. Please fix it before merging.


The following is an example of expected return output for a single item:
```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Fenced code blocks should have a language specified (MD040/fenced-code-language)

For more information, see the Markdownlint docs for MD040/fenced-code-language.

⛔️ This change is a requirement. Please fix it before merging.


This is the response you should expect to get back from that endpoint:

```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content quality library markdownlint says:

  • Fenced code blocks should have a language specified (MD040/fenced-code-language)

For more information, see the Markdownlint docs for MD040/fenced-code-language.

⛔️ This change is a requirement. Please fix it before merging.

@github-actions github-actions bot added the changes requested This pull request has changes requested prior to merging label Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changes requested This pull request has changes requested prior to merging engine guides Changes the Engine guides
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant