Skip to content
Merged

typos #585

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions openapi/components/paths/economy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
paths:
/Admin/transactions:
get:
operationId: getAdminTransactions

Check notice on line 9 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listAdminTransactions.
summary: Get Admin Transactions
description: Get all own Admin transactions.
tags:
Expand All @@ -32,14 +32,14 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/economy/TransactionResponse.yaml

Check warning on line 36 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
x-internal: true
/Steam/transactions:
get:
operationId: getSteamTransactions

Check notice on line 42 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listSteamTransactions.
summary: List Steam Transactions
description: Get all own Steam transactions.
tags:
Expand All @@ -64,8 +64,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/economy/TransactionResponse.yaml

Check warning on line 68 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"/assetReview/{assetReviewId}/notes":
Expand All @@ -91,7 +91,7 @@
$ref: ../responses/MissingCredentialsError.yaml
/auth/user/subscription:
get:
operationId: getCurrentSubscriptions

Check notice on line 94 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listCurrentSubscriptions.
summary: Get Current Subscriptions
description: Get a list of all current user subscriptions.
tags:
Expand All @@ -105,7 +105,7 @@
$ref: ../responses/MissingCredentialsError.yaml
/economy/licenses/active:
get:
operationId: getActiveLicenses

Check notice on line 108 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listActiveLicenses.
summary: Get Active Licenses
description: Gets active licenses
tags:
Expand Down Expand Up @@ -165,7 +165,7 @@
- $ref: ../parameters.yaml#/sortProductPurchase
- $ref: ../parameters.yaml#/orderShort
get:
operationId: getProductPurchases

Check notice on line 168 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listProductPurchases.
summary: Get Product Purchases
description: Gets product purchases
tags:
Expand All @@ -189,15 +189,15 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/economy/ProductPurchaseResponse.yaml

Check warning on line 193 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"/economy/purchases/{productPurchaseId}/stacks":
parameters:
- $ref: ../parameters.yaml#/productPurchaseId
get:
operationId: getProductPurchaseStacks

Check notice on line 200 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listProductPurchaseStacks.
summary: Get Product Purchase Stacks
description: Gets stacks for a product purchase
tags:
Expand All @@ -205,8 +205,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/economy/ProductPurchaseStacksResponse.yaml

Check warning on line 209 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
"401":
$ref: ../responses/MissingCredentialsError.yaml
/economy/seller/eligibility:
Expand Down Expand Up @@ -247,7 +247,7 @@
- $ref: ../parameters.yaml#/hydrateListings
- $ref: ../parameters.yaml#/storeView
get:
operationId: getStoreShelves

Check notice on line 250 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listStoreShelves.
summary: Get Store Shelves
description: Gets the shelves for a store
tags:
Expand Down Expand Up @@ -290,8 +290,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/economy/LicenseGroupResponse.yaml

Check warning on line 294 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
/listing:
Expand Down Expand Up @@ -327,8 +327,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/economy/ProductListingResponse.yaml

Check warning on line 331 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
"401":
$ref: ../responses/MissingCredentialsError.yaml
put:
Expand All @@ -346,8 +346,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/economy/ProductListingResponse.yaml

Check warning on line 350 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
"401":
$ref: ../responses/MissingCredentialsError.yaml
delete:
Expand Down Expand Up @@ -396,8 +396,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/economy/ProductListingResponse.yaml

Check warning on line 400 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
"401":
$ref: ../responses/MissingCredentialsError.yaml
put:
Expand Down Expand Up @@ -434,7 +434,7 @@
$ref: ../responses/MissingCredentialsError.yaml
/subscriptions:
get:
operationId: getSubscriptions

Check notice on line 437 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listSubscriptions.
summary: List Subscriptions
description: 'List all existing Subscriptions. For example, "vrchatplus-monthly" and "vrchatplus-yearly".'
tags:
Expand Down Expand Up @@ -462,7 +462,7 @@
$ref: ../responses/MissingCredentialsError.yaml
/tokenBundles:
get:
operationId: getTokenBundles

Check notice on line 465 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listTokenBundles.
summary: List Token Bundles
description: Gets the list of token bundles
tags:
Expand All @@ -478,7 +478,7 @@
parameters:
- $ref: ../parameters.yaml#/mostRecentFlag
get:
operationId: getBulkGiftPurchases

Check notice on line 481 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listBulkGiftPurchases.
summary: Get Bulk Gift Purchases
description: Get bulk gift purchases made by the user.
tags:
Expand Down Expand Up @@ -516,8 +516,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/economy/BalanceResponse.yaml

Check warning on line 520 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"/user/{userId}/balance/earnings":
Expand All @@ -532,8 +532,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/economy/BalanceResponse.yaml

Check warning on line 536 in openapi/components/paths/economy.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"/user/{userId}/economy/account":
Expand Down Expand Up @@ -719,7 +719,7 @@
- $ref: ../parameters.yaml#/subscriptionId
get:
operationId: getUserCreditsEligible
summary: Get User Credits Eligiblity
summary: Get User Credits Eligibility
description: Get the user's eligibility status for subscriptions based on available credits.
tags:
- economy
Expand All @@ -736,7 +736,7 @@
- $ref: ../parameters.yaml#/steamId
get:
operationId: getUserSubscriptionEligible
summary: Get User Subscription Eligiblity
summary: Get User Subscription Eligibility
description: Get the user's eligibility status for subscriptions.
tags:
- economy
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/paths/favorites.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ paths:
- $ref: ../parameters.yaml#/offset
- $ref: ../parameters.yaml#/userIdAdmin
- name: ownerId
description: The owner of whoms favorite groups to return. Must be a UserID.
description: The owner whose favorite groups to return. Must be a UserID.
in: query
schema:
type: string
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/paths/files.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ paths:

**Version Note:** Version 0 is always when the file was created. The real data is usually always located in version 1 and up.

**Extension Note:** Files are not guaranteed to have a file extensions. UnityPackage files tends to have it, images through this endpoint do not. You are responsible for appending file extension from the `extension` field when neccesary.
**Extension Note:** Files are not guaranteed to have a file extensions. UnityPackage files tends to have it, images through this endpoint do not. You are responsible for appending file extension from the `extension` field when necessary.
tags:
- files
security:
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/paths/groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1106,7 +1106,7 @@ paths:
post:
operationId: initiateOrAcceptGroupTransfer
summary: Initiate or Accept Group Transfer
description: To initiate, must be logged in as the current owner and specify the transferTargetId in the body. To accept, must be logged in as the user targetted by a pending transfer, no body is required.
description: To initiate, must be logged in as the current owner and specify the transferTargetId in the body. To accept, must be logged in as the user targeted by a pending transfer, no body is required.
tags:
- groups
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/paths/notifications.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: notifications
description: Notifiations Docs
description: Notifications Docs
version: "1.0"
paths:
/auth/user/notifications:
Expand Down
4 changes: 2 additions & 2 deletions openapi/components/paths/playermoderation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ info:

## Implementation details

There are three different user-targetted permission options:
There are three different user-targeted permission options:

- Mode 1: interactOn/unmute/unblock
- Mode 2: interactOff/mute/block
Expand All @@ -32,7 +32,7 @@ info:

As of October 2022, `showAvatar` and `hideAvatar` has been moved to local storage.
Sending these types to the API will result in a 200 OK response, but the API will **not** store them.
More information is avaiable on VRChat's official [documentation on Local Storage](https://docs.vrchat.com/docs/local-vrchat-storage).
More information is available on VRChat's official [documentation on Local Storage](https://docs.vrchat.com/docs/local-vrchat-storage).
version: "1.0"
paths:
/auth/user/playermoderations:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ properties:
minLength: 8
subscribe:
type: boolean
description: Whether to recieve promotional emails
description: Whether to receive promotional emails
username:
type: string
description: Display Name / Username (Username is a sanitized version)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Error response when trying to see favourited avatars of another user without sufficient admin permissions.
description: Error response when trying to see favorited avatars of another user without sufficient admin permissions.
content:
application/json:
examples:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Error response due to non existant instance
description: Error response due to non existent instance
content:
application/json:
examples:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Error response when trying to reset an Invite Message whos slot doesn't exist.
description: Error response when trying to reset an Invite Message whose slot doesn't exist.
content:
application/json:
examples:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Error response when trying to invite someome whom you are not friends with.
description: Error response when trying to invite someone whom you are not friends with.
content:
application/json:
examples:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Returns a list of Notifcation objects.
description: Returns a list of Notification objects.
content:
application/json:
schema:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Returns a single Notifcation object.
description: Returns a single Notification object.
content:
application/json:
examples:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Returns a list of NotifcationV2 objects.
description: Returns a list of NotificationV2 objects.
content:
application/json:
schema:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Returns a single NotifcationV2 object.
description: Returns a single NotificationV2 object.
content:
application/json:
schema:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Returns a single SentNotifcation object.
description: Returns a single SentNotification object.
content:
application/json:
examples:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Error response when trying create a world without having the neccesary Trust rank yet.
description: Error response when trying create a world without having the necessary Trust rank yet.
content:
application/json:
examples:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: Error response when trying to see favourited worlds of another user without sufficient admin permissions.
description: Error response when trying to see favorited worlds of another user without sufficient admin permissions.
content:
application/json:
examples:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
title: CalendarEventRecurrenceEndTyoe
title: CalendarEventRecurrenceEndType
type: string
description: How a recurring event stops being scheduled
enum:
Expand Down
6 changes: 3 additions & 3 deletions openapi/components/tags.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@
- name: jams
description:
$ref: ./paths/jams.yaml#/info/description
- name: miscellaneous
description:
$ref: ./paths/miscellaneous.yaml#/info/description
- name: notifications
description:
$ref: ./paths/notifications.yaml#/info/description
Expand All @@ -52,6 +55,3 @@
- name: worlds
description:
$ref: ./paths/worlds.yaml#/info/description
- name: miscellaneous
description:
$ref: ./paths/miscellaneous.yaml#/info/description
5 changes: 5 additions & 0 deletions pnpm-workspace.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
packages:
- .
allowBuilds:
Comment thread
jellejurre marked this conversation as resolved.
core-js: true
esbuild: true
protobufjs: true
unrs-resolver: true
1 change: 1 addition & 0 deletions spectral/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import { parseArgs } from "node:util";
import { error, notice, summary, warning } from "@actions/core";
import { Document, Ruleset, Spectral } from "@stoplight/spectral-core";
import Parsers from "@stoplight/spectral-parsers";
import Bun from "bun";
Comment thread
jellejurre marked this conversation as resolved.

import { defaultRuleset } from "./ruleset";

Expand Down
21 changes: 20 additions & 1 deletion spectral/lib/typos.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,26 @@ const words = [
"favorited",
"vrchatplus",
"unban",
"unmute"
"unmute",
"spritesheet",
"despawns",
"urlencode",
"unmoderates",
"standalonewindows",
"unknownplatform",
"booping",
"unequip",
"playermoderation",
"unmoderate",
"interactable",
"bitmask",
"unbans",
"unequips",
"equippable",
"unmoderated",
"unmoderating",
"webform",
"recents"
];

const suggestWords = [
Expand Down
Loading