Template:API endpoint infobox
From Guild Wars 2 Wiki
Jump to navigationJump to search
/
- HTTP method
- GET
- Format
- json
- API version
- version 2
- Release date
- ?
- Scope
- none
- Optional
- none
Description[edit]
This infobox is used in the API namespace to document API endpoints.
Usage[edit]
{{API endpoint infobox
| endpoint =
| method =
| format =
| version =
| release =
| scope =
| optional =
}}
Parameters[edit]
- endpoint
- The endpoint address
- version
- The API version
- method
- Optional. The HTTP method. Default
GET. - format
- Optional. The response format. Default
json. - release
- Optional. The date the endpoint was made available.
- scope
- Optional. The scopes required to access the resource. Use a comma-separated list of values.
- optional
- Optional. The scopes that grant additional resources if present. Use a comma-separated list of values.
- status
- Optional. If set equal to "historical" or "unimplemented", then an additional parameter "status notes" is available. Intended to be used to identify inactive endpoints.
- parent endpoint
- Optional. The pagename of the parent endpoint.
- requires further expansion
- Optional. Whether an endpoint can be accessed directly or requires further expansion before returning valid resources. Defaults to "n".
