Patrick a027d5ff9e 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
2022-12-20 10:58:57 +00:00
2021-10-12 22:10:36 +02:00
2022-07-11 08:47:48 +00:00
2021-06-15 15:45:59 +02:00
2022-08-29 13:26:58 +00:00
2021-12-07 11:02:35 +01:00
2022-07-12 20:14:34 +02:00
2020-09-09 09:24:51 +02:00
2022-02-15 13:44:23 +01:00
2021-07-04 20:08:55 +01:00
2022-11-10 17:52:03 +02:00
2022-01-06 13:05:04 +01:00

Medusa

Medusa

Documentation | Medusa Admin Demo | Website

An open source composable commerce engine built for developers.

Medusa is released under the MIT license. Current CircleCI build status. PRs welcome! Product Hunt Discord Chat Follow @medusajs

Getting Started

Follow our quickstart guide to learn how to set up a Medusa server.

Requirements

You can check out this documentation for details about setting up your environment.

What is Medusa

Medusa is an open source composable commerce engine built with Node.js. Medusa enables developers to build scalable and sophisticated commerce setups with low effort and great developer experience.

You can learn more about Medusas architecture in our documentation.

Features

You can learn about all of the ecommerce features that Medusa provides in our documentation.

Roadmap

Write-ups for all features will be made available in Github discussions before starting the implementation process.

2022

  • Admin revamp
  • Tax API
  • Tax Calculation Strategy
  • Cart Calculation Strategy
  • Customer Groups API
  • Promotions API
  • Price Lists API
  • Price Selection Strategy
  • Import / Export API
  • Sales Channel API
  • Extended Order API (managing placed orders)
  • PaymentCollection API (collecting payments separate from carts and draft orders)
  • Multi-warehouse API
  • Extended Product API (custom fields, publishing control, and more)

Plugins

Check out our available plugins that you can install and use instantly on your Medusa server.

Contributions

Please check our contribution guide for details about how to contribute to both our codebase and our documentation.

Upgrade Guides

Follow our upgrade guides on the documentation to keep your Medusa project up-to-date.

Community & Support

Use these channels to be part of the community, ask for help while using Medusa, or just learn more about Medusa:

  • Discord: This is the main channel to join the community. You can ask for help, showcase your work with Medusa, and stay up to date with everything Medusa.
  • GitHub Issues: for sending in any issues you face or bugs you find while using Medusa.
  • GitHub Discussions: for joining discussions and submitting your ideas.
  • Medusa Blog: find diverse tutorials and company news.
  • Twitter
  • LinkedIn

License

Licensed under the MIT License

Description
No description provided
Readme 539 MiB
Languages
TypeScript 84.9%
JavaScript 14.8%
Shell 0.2%