Skip to content

Commit

Permalink
resolve merge conflict and minor readme clean ups
Browse files Browse the repository at this point in the history
  • Loading branch information
CalumW1 committed Oct 9, 2024
2 parents 4d733bf + 1b28572 commit 16c3ab1
Show file tree
Hide file tree
Showing 3 changed files with 126 additions and 13 deletions.
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/01_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Bug Report
description: "Found a bug? We'd appreciate if you'd first search through our open issues and docs, to make sure the issue isn't already known."
labels: ['bug']
title: 'bug: '
body:
- type: checkboxes
attributes:
label: 'Duplicate Check'
options:
- label: 'I have [searched R6StatsAPI bugs](https://github.com/CalumW1/R6StatAPI/issues?q=is%3Aissue+label%3Abug+) and there are no duplicates'
required: true
- type: textarea
id: 'describe-the-bug'
attributes:
label: 'Describe the bug'
description: 'A clear and concise description of what the bug is.'
placeholder: Tell us what you see.
validations:
required: true
- type: textarea
id: 'to-reproduce'
attributes:
label: 'To reproduce'
description: 'Bug reports with clear reproduction will get prioritized higher and addressed more quickly.'
placeholder: "Steps to reproduce: 1. Go to '...' 2. Click on '...' 3. Scroll down to '...' 4. See error '...'"
validations:
required: true
- type: textarea
id: 'expected-behavior'
attributes:
label: 'Expected behavior'
description: 'A clear and concise description of what you expected to happen.'
placeholder: Tell us what you expect to see.
validations:
required: false
- type: textarea
id: 'screenshots'
attributes:
label: 'Screenshots'
description: 'If applicable, add screenshots/videos to help explain your problem. While optional, screenshots help expedite the time in which your bug is addressed.'
validations:
required: false
- type: dropdown
id: 'os'
attributes:
label: 'Platform'
multiple: false
options:
- Pc
- console
- both
- not testet
validations:
required: true
- type: textarea
id: 'additional-context'
attributes:
label: 'Additional context'
description: 'Add any other context about the problem here'
validations:
required: false
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/02_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Feature Request
description: "Have a great new idea? We'd love to know, please search through our existing feature requests, and upvote it if it's already been filed."
labels: ['enhancement']
title: 'rfc: '
body:
- type: checkboxes
attributes:
label: 'Duplicate Check'
options:
- label: 'I have [searched R6StatsAPI feature requests](https://github.com/CalumW1/R6StatAPI/issues?q=label%3Aenhancement+) and there are no duplicates'
required: true
- type: textarea
id: 'describe-solution'
attributes:
label: "Describe the solution you'd like?"
description: 'A clear and concise description of what you want to happen.'
validations:
required: true
- type: textarea
id: 'expected-responsoe'
attributes:
label: 'Do you have a expected response? Please describe.'
description: 'A clear example response in json format'
placeholder: '{...'
validations:
required: false
- type: textarea
id: 'related-to-problem'
attributes:
label: 'Is your feature request related to a problem? Please describe.'
description: 'A clear and concise description of what the problem is.'
placeholder: "I'm always frustrated when [...]"
validations:
required: false
- type: textarea
id: 'additional-context'
attributes:
label: 'Additional context'
description: 'Add any other context or screenshots about the feature request here. If you want to upload a picture you can drag one in from Finder.'
validations:
required: false
- type: dropdown
id: 'importance'
attributes:
label: 'How important is this feature to you?'
multiple: false
options:
- '1 (Not too important)'
- '2'
- '3'
- '4'
- "5 (Can't work without it!)"
validations:
required: true
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ await api.Login(email, password)
```

<details>
<summary>Response</summary>
<summary> Example Response</summary>

```
ewogICJ2ZXIiOiAiMSIsCiAgImFpZCI6ICJlM2Q1ZWE5ZS01MGJkLTQzYjctODhiZi0zOTc5NGY0ZTNkNDAiLAogICJlbnYiOiAiUHJvZCIsCiAgInNpZCI6ICI2YzVlY2E4MS1jYWI3LTQ0NjItOWUzOC04YjZkODA5OWQ1ZjEiLAogICJ0eXAiOiAiSldFIiwKICAiZW5jIjogIkExMjhDQkMiLAogICJpdiI6ICJPellRVVNkSkswNzJURTFJTXVpdFhnIiwKICAiaW50IjogIkhTMjU2IiwKICAia2lkIjogImFkNWNjMzFhLWI2ZmQtNGYyZS04N2JmLTNjZjRkOTc1OTY2NSIKfQ.-F6ZqzG9mOze0HRYJh3Ub23dQUR9BLR-VM7hMgbisN3tQZ1XLgZFyVH2sFmmX4VMPEKVG9e_PGLnPgrtyBfVkyyQBrjlppeWJXICTQPqj1-gg-0KCX4V3DkEd_o1VYbUAeuiA2QBtUeYIaxFluqxTZ5fr6fcGZvfB8npqMgahHLdcwyzcykp8klKbhOF5L17lUXMai5VgGT33o5N3xxx6wBZL97lXZ_jK1Yd67jPTsL2guB24meGrdR2HBtrB3N6ZR2cZnrFyfDuQzdotf0HsRlX8kATI2wOiADZ8RQS6pRtfRlFXqk-HZ0bsCAdQrs4wOzwL5ZiijfS63rAif_6t1K-KYffiQ3ExXPX6jG2OVK8evkR8fP-vS_aNF1iXE8j4ctrti8PezaOgJUmlRRBwrq29hxJJs5fIsP_EGkg_5rztX4hZtvDNRM9vRsIfAt3aPci5CpyhZs2oAbjLYqA1mEOaY8PODCm4pv3qS8zFBXlPAerCW-8ccYfsAmxEMCrZCxG210BDpZQ5c4JHk_XBij6TqE7yWjg_SO0qR_6eFhRKo5lpLbHAao7EWnfuh03dr_Q210QbiyYE5lCQ4RNapfEug0i5flhlJ55asjlQq6UOt21iJFEHBKHjJLj1vSy7WR347iUlYG8bRtcKHXvL2jD6WP18knlIZIWK7XQtR90TpiYV-WY4hqy7UMqD4yFe4Ah-jP58H8ADYA0F_wzIMGenfuDV4mQ_PyjSQuEynYmycmJyjFGeSFye8N-VvGJvcxozY5NMsYmHUqFLxZ1I6HlZivB_6znSzIK5mzqkfR24tPKQv_3T2VHbTfmN_E-4e5enq3F9tayTOSGNad6sSvP_dBao50w-5JBx86i7xJyK2IRGdjizfTbmzUyBQg5zeDbrRHTrAqnaV8NglOF8I2kS3rbxKH9qfUk1MrNdgi7ZJA34tFfu7XRMvUQN2asmrYhvBC0XlyABCCnn3mPy4abQgstYS9wX-itoVSru0_YS8QCIrffpRZkWANjAIsmERWiOGMXlwE5j2wB50M4_JI_gWGplgmn_9nZrtIeGJBYRUj4j4zl495lowDfTPBOdt3QOLx8OAGrHTwDKj6TOCZ6Nh8e7DjMmgm8c8i3n1WmQu6tkT0f3kOUbt1m3941q93R9kd9MR5H28wQHDH8ffTeGPTbhitgWy9WpsnOujwIm3Nnq72L1hkB5UeJobb7uJ6x8bwMaUUjlP8S6Qpa816YKoFQlFpI-dFPaf0W4gOlxSOafLyS6oewtKQlcADTZ5uwbEx4CPRhm9kZwKdekdol6lcEBk-07z8ppev0pNJl45gztd8zuqg_tqfVQtdSh53-xYqh_7FzzsdieCHCx-I0e9jv4QqAZ_VqAGb5ENNPsYHl9bMQYHdY-4npOfK5A4QgXwConKc2KD9dzhOTuohcz5mTgnP5yCkBOxmoHOXcNqh-HV6eAtg-ayrVpG63BlFND_uxAhJ-hnK0STCID-2JI3bvBr4p6V4L6_RT8X1EU_cCw4Ohr-cO9EqZT8f8qjiVzOAqZY6uPe8DfkANkSBIfmXL6A-duTGYoetHQXmvFxiM_MB10LP6FL1eVI2ZNwCXgJ0HgZkQ-_Ul5iBPEeuEIx3tCXpk6aoq1nIC6wdj_JJx9kTwICF3tOvPbUXI1jczVu_36HFi2fZxM6inuZ1uzC3ewfY_opccdDRLSZknlHs29ZPsOfiAX_hrm0NCGdE7MJMdC9aeGsGdll2ujxGZ90CKFuayH9pJsHgpW5d8Ly8v0xCJFc2qiTGAF-XJq9XCIroOBussSi4mLsJCr97jB9KjAY12zYIb-Pfhlnlba7YqX6otIO8oWG5koYzaj5ipqixOXCrDrXAHKdHFFeAYYq3Ojk1t96o_oRkQh1WBspTmmdRz1UOlUsBbVr4q4a0mj0cgFjKIjhv54Kj2xBnpf5GxmDLV9YEE3bqfMGrCy-rIR45CLGx6mBdRmf999dmb3wOM3iPlbgloF2TDTvFdaokQ4lYX51x4E0io8aFtJIrQX8EoPeFWvG8lea20h4e7TeEFx3n07rnPY22HxAFw26spFDxwBPAc6iLxEt_NoerdANtPE_-wUnqrZJ3-Oblvk6M6HOh_vsj-yJi4QC88sxqHhWiBRhW2vCePfY1RDJvD2Hq66Xc2Engp4drZhX1Drv4PnTPk8nISNVelUxGx89B-2KZtIsBUZiUxrY7bZj6Px2FmC2Ro5dOKIjQwZA6D-uEkAhBFsibp3tOIzWAjQChCR89hJy9IS2O7PMWs31rxINAKdx43jb6llgTRsUGDXYLL1eKYecUd7orY8frlAYXU1xLmDBzBpn6wzbMRNNoFfiI1KG9rUKR8EDPUv26GcfsBzkuSHeFXSi_Xhg.oMj2gpJl_2eOj-pFuYvFyWr_t1JR48zgb2st82KTKWk
Expand All @@ -114,7 +114,7 @@ await api.getUserByUsername(userName, platform);
```

<details>
<summary>Response</summary>
<summary> Example Response</summary>

```
{
Expand Down Expand Up @@ -146,11 +146,8 @@ Gets a user by userId
await api.getUserById(user.userId, platform);
```

Example response

<details>
<summary>Response</summary>

<summary> Example Response</summary>
```
[
{
Expand Down Expand Up @@ -207,14 +204,15 @@ gets the progression for a user
await api.getUserProgression(user.userId, platform);
```

Example response

<details>
<summary> Example Response</summary>
```
{
level: 326,
xp: 129949
}
```
</details>

#### Get server status

Expand All @@ -226,8 +224,8 @@ platforms: pc, xbox, ps4
await api.getServerStatus(platfrom)
```

Example response

<details>
<summary> Example Response</summary>
```
{
MDM: '4075',
Expand All @@ -240,6 +238,7 @@ Example response
impactedFeatures: []
}
```
</details>

#### Get user rank

Expand All @@ -255,8 +254,7 @@ await api.getUserRank(player.userId, platfrom);
```

<details>
<summary>Response</summary>

<summary> Example Response</summary>
```
{
casual: {
Expand Down Expand Up @@ -822,7 +820,7 @@ await api.getUserOperators(
```

<details>
<summary>Response</summary>
<summary> Example Response</summary>
```
{
ranked: {
Expand Down

0 comments on commit 16c3ab1

Please sign in to comment.