chore(oas): PascalCase for schemas + remove x-resourceId (#2847)
### What Rename all JSDoc OAS `@schema` and `$ref: #/components/schemas/` from snake_case to PascalCase, `foo_bar -> FooBar` Extra scope: Remove `x-resourceId` from JSDoc OAS. ### Why Classes use PascalCase as a convention but the OAS @schemas describing them were using snake_case. OAS code generators tend to use the schema name when generating typed models. In order to avoid mismatch between source code, the OAS, and the generated client code, it is advised to align OAS @schemas formatting to the classes they represent. Extra scope: x-resourceId is not a widely used OAS property. It's current usage in our OAS does not provide additional value. Therefore, we recommend to remove it in order to have one less item to maintain. ### How Good old search & replace. Regex search to further make sure we didn't miss any. The scope is limited to `@schema` definition and their usage in `$ref: #/components/schemas/`. ### Test * Ran OAS validator. * Ran docs build script. Expect no visible changes to the documentation. Resolves: CORE-852, CORE-859
This commit is contained in:
@@ -42,10 +42,9 @@ export class Note extends SoftDeletableEntity {
|
||||
}
|
||||
|
||||
/**
|
||||
* @schema note
|
||||
* @schema Note
|
||||
* title: "Note"
|
||||
* description: "Notes are elements which we can use in association with different resources to allow users to describe additional information in relation to these."
|
||||
* x-resourceId: note
|
||||
* type: object
|
||||
* required:
|
||||
* - value
|
||||
@@ -74,7 +73,7 @@ export class Note extends SoftDeletableEntity {
|
||||
* example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
|
||||
* author:
|
||||
* description: Available if the relation `author` is expanded.
|
||||
* $ref: "#/components/schemas/user"
|
||||
* $ref: "#/components/schemas/User"
|
||||
* created_at:
|
||||
* type: string
|
||||
* description: "The date with timezone at which the resource was created."
|
||||
|
||||
Reference in New Issue
Block a user