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

Generate the endpoints.md out of source comments #62

Open
queicherius opened this issue Apr 10, 2019 · 0 comments
Open

Generate the endpoints.md out of source comments #62

queicherius opened this issue Apr 10, 2019 · 0 comments

Comments

@queicherius
Copy link
Owner

queicherius commented Apr 10, 2019

Something ala:

/**
 * Information about the available world bosses.
 *
 * Usage: `api().worldbosses()`
 */
class WorldbossesEndpoint extends AbstractEndpoint {
  constructor (client) {
    super(client)
    this.url = '/v2/worldbosses'
    this.isPaginated = true
    this.isBulk = true
    this.isLocalized = true
    this.cacheTime = 24 * 60 * 60
  }
}

// ... code ...

Should be easily transformed into something like this:

- [`api().worldbosses()`](#apiworldbosses) - Information about the available world bosses.

<!-- Further down -->

### `api().worldbosses()`

> Information about the available world bosses.

- **API-URL:** [/v2/worldbosses](https://api.guildwars2.com/v2/worldbosses)
- **Paginated:** Yes
- **Bulk expanding:** Yes
- **Authenticated:** No
- **Localized:** Yes
- **Cache time:** 24 hours

<sup>[↑ Back to the overview](#available-endpoints)</sup>

---
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant