Skip to content

Commit

Permalink
Repair Japanese anchors (#568)
Browse files Browse the repository at this point in the history
  • Loading branch information
willeastcott authored Jan 29, 2024
1 parent 62e9a29 commit 7a6377a
Show file tree
Hide file tree
Showing 8 changed files with 182 additions and 182 deletions.
20 changes: 10 additions & 10 deletions docs/user-manual/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The REST API is currently in beta. This means we may change certain endpoints an

:::

## Authorization
## Authorization {#authorization}

You can only access the REST API via https. In order to access the REST API you need to use an Access Token. You can generate an Access Token by going to your Organization's Account page.

Expand Down Expand Up @@ -43,39 +43,39 @@ For example:
curl -H "Authorization: Bearer nesgdxhiqe7hylfilr6ss1rds0gq1uj8" https://playcanvas.com/api/...
```

## Parameters
## Parameters {#parameters}

Various routes accept a number of parameters. For GET requests if the parameter is not part of the URL, you can pass it as an HTTP query string parameter. For POST, PUT and DELETE requests parameters not included in the URL should be encoded as JSON with a Content-Type of 'application/json'.

There are several common parameters that are used in each endpoint:

### project_id
### project_id {#project_id}

This can be found in the URL on the project overview page.

![Project ID][6]

### scenes
### scenes {#scenes}

When opening a scene in the Editor, the scene id is in the URL.

![Scene ID][7]

### branch_id
### branch_id {#branch_id}

This is found in the [version control][5] panel and can be selected and copied.

![Branch ID][8]

## Response Format
## Response Format {#response-format}

Our REST API is following some generic guidelines when it comes to the response format of each API call.

#### GET resource
#### GET resource {#get-resource}

If you are trying to GET a single resource the response will be a JSON object with the resource you requested.

#### GET multiple resources
#### GET multiple resources {#get-multiple-resources}

If you are trying to GET multiple resources like for example listing the Apps of a Project you will get a JSON object with this format:

Expand Down Expand Up @@ -110,7 +110,7 @@ So for example to get 32 items after the first 16 items you would send this requ
https://playcanvas.com/api/items?limit=32&skip=16
```

#### Errors
#### Errors {#errors}

When an error is raised you will get a JSON object with this format:

Expand All @@ -122,7 +122,7 @@ When an error is raised you will get a JSON object with this format:

Also the status code of the response will be the appropriate HTTP error code.

## Rate Limiting
## Rate Limiting {#rate-limiting}

Calls to the REST API have a rate limit. Check your actual limits by querying [this endpoint](https://playcanvas.com/api/ratelimits). There are different rate limits depending on the request:

Expand Down
4 changes: 2 additions & 2 deletions docs/user-manual/editor/menus-and-toolbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ title: Menu and Toolbar
sidebar_position: 1
---

## Menu
## Menu {#menu}

![Menu][1]

The menu is available by clicking on the PLAYCANVAS icon and contains a complete list of all the commands that you can perform on your scene. If you can't find a button or remember a hotkey, the command will always be available in the menu.

## Toolbar
## Toolbar {#toolbar}

![Toolbar][2]

Expand Down
Loading

0 comments on commit 7a6377a

Please sign in to comment.