Skip to content

Commit

Permalink
docs(links): update anymaniax to orval-labs
Browse files Browse the repository at this point in the history
  • Loading branch information
anymaniax committed Jul 22, 2024
1 parent 5585779 commit 7967aaf
Show file tree
Hide file tree
Showing 34 changed files with 149 additions and 149 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
When contributing to `orval`, whether on GitHub or in other community spaces:

- Be respectful, civil, and open-minded.
- Before opening a new pull request, try searching through the [issue tracker](https://github.com/anymaniax/orval/issues) for known issues or fixes.
- Before opening a new pull request, try searching through the [issue tracker](https://github.com/orval-labs/orval/issues) for known issues or fixes.
- If you want to make code changes based on your personal opinion(s), make sure you open an issue first describing the changes you want to make, and open a pull request only when your suggestions get approved by maintainers.

## How to Contribute

### Prerequisites

In order to not waste your time implementing a change that has already been declined, or is generally not needed, start by [opening an issue](https://github.com/anymaniax/orval/issues/new) describing the problem you would like to solve.
In order to not waste your time implementing a change that has already been declined, or is generally not needed, start by [opening an issue](https://github.com/orval-labs/orval/issues/new) describing the problem you would like to solve.

### Setup your environment locally

Expand All @@ -19,7 +19,7 @@ _Some commands will assume you have the Github CLI installed, if you haven't, co
In order to contribute to this project, you will need to fork the repository:

```bash
gh repo fork anymaniax/orval
gh repo fork orval-labs/orval
```

then, clone it to your local machine:
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![npm version](https://badge.fury.io/js/orval.svg)](https://badge.fury.io/js/orval)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![tests](https://github.com/anymaniax/orval/actions/workflows/tests.yaml/badge.svg)](https://github.com/anymaniax/orval/actions/workflows/tests.yaml)
[![tests](https://github.com/orval-labs/orval/actions/workflows/tests.yaml/badge.svg)](https://github.com/orval-labs/orval/actions/workflows/tests.yaml)
[![orval](https://snyk.io/advisor/npm-package/orval/badge.svg)](https://snyk.io/advisor/npm-package/orval)

<p align="center">
Expand All @@ -22,31 +22,31 @@

You can find below some samples:

- [react app](https://github.com/anymaniax/orval/tree/master/samples/react-app)
- [react query](https://github.com/anymaniax/orval/tree/master/samples/react-query)
- [svelte query](https://github.com/anymaniax/orval/tree/master/samples/svelte-query)
- [vue query](https://github.com/anymaniax/orval/tree/master/samples/vue-query)
- [react app with swr](https://github.com/anymaniax/orval/tree/master/samples/react-app-with-swr)
- [angular app](https://github.com/anymaniax/orval/tree/master/samples/angular-app)
- [hono](https://github.com/anymaniax/orval/tree/master/samples/hono)
- [next app with fetch](https://github.com/anymaniax/orval/tree/master/samples/next-app-with-fetch)
- [react app](https://github.com/orval-labs/orval/tree/master/samples/react-app)
- [react query](https://github.com/orval-labs/orval/tree/master/samples/react-query)
- [svelte query](https://github.com/orval-labs/orval/tree/master/samples/svelte-query)
- [vue query](https://github.com/orval-labs/orval/tree/master/samples/vue-query)
- [react app with swr](https://github.com/orval-labs/orval/tree/master/samples/react-app-with-swr)
- [angular app](https://github.com/orval-labs/orval/tree/master/samples/angular-app)
- [hono](https://github.com/orval-labs/orval/tree/master/samples/hono)
- [next app with fetch](https://github.com/orval-labs/orval/tree/master/samples/next-app-with-fetch)

### Playground

Try Orval out for yourself using our [Playgound](https://orval.dev/playground) application!

## Star History

<a href="https://star-history.com/#anymaniax/orval&Date">
<a href="https://star-history.com/#orval-labs/orval&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=anymaniax/orval&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=anymaniax/orval&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=anymaniax/orval&type=Date" />
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=orval-labs/orval&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=orval-labs/orval&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=orval-labs/orval&type=Date" />
</picture>
</a>

### All Thanks To Our Contributors:

<a href="https://github.com/anymaniax/orval/graphs/contributors">
<a href="https://github.com/orval-labs/orval/graphs/contributors">
<img src="https://contrib.rocks/image?repo=anymaniax/orval" />
</a>
8 changes: 4 additions & 4 deletions docs/src/components/Footer.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export const Footer = (props) => {
<ul className="mt-4">
<li className="mt-4">
<a
href="https://github.com/anymaniax/orval/releases"
href="https://github.com/orval-labs/orval/releases"
className="text-base leading-6 text-gray-500 hover:text-gray-900"
>
Releases
Expand All @@ -54,12 +54,12 @@ export const Footer = (props) => {
<li className="mt-4">
<a
className="github-button"
href="https://github.com/anymaniax/orval"
href="https://github.com/orval-labs/orval"
data-color-scheme="no-preference: light; light: light; dark: dark;"
data-icon="octicon-star"
data-size="large"
data-show-count="true"
aria-label="Star anymaniax/orval on GitHub"
aria-label="Star orval-labs/orval on GitHub"
>
Star
</a>
Expand All @@ -81,7 +81,7 @@ export const Footer = (props) => {
</svg>
</a>
<a
href="https://github.com/anymaniax"
href="https://github.com/orval-labs"
className="ml-6 text-gray-400 hover:text-gray-500"
>
<span className="sr-only">GitHub</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/guides/angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Checkout the [orval config](../reference/configuration/full-example) reference t

The Angular mode will generate automatically two classes. One abstract with the definition and a service with the implementation. You should add the service inside a module and use it where you want.

You can checkout an example <a href="https://github.com/anymaniax/orval/tree/master/samples/angular-app" target="_blank">here</a>
You can checkout an example <a href="https://github.com/orval-labs/orval/tree/master/samples/angular-app" target="_blank">here</a>

### How to set a backend url

Expand All @@ -38,6 +38,6 @@ You can use an interceptor to automatically add the url of your API. Like you wo

You should define your mock inside the environment file. If you don't do that you will add all the dependencies to your bundle.

You can for example add a property `modules` and add a MockModule inside which will setup your mocks. You can check an example <a href="https://github.com/anymaniax/orval/tree/master/samples/angular-app/src/api/mocks" target="_blank">here</a>
You can for example add a property `modules` and add a MockModule inside which will setup your mocks. You can check an example <a href="https://github.com/orval-labs/orval/tree/master/samples/angular-app/src/api/mocks" target="_blank">here</a>

You can also check the msw example <a href="https://github.com/mswjs/examples/tree/master/examples/rest-angular" target="_blank">here</a>
2 changes: 1 addition & 1 deletion docs/src/pages/guides/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: basics
title: Basics
---

You should define a OpenAPI specification (example <a href="https://github.com/anymaniax/orval/blob/master/samples/basic/petstore.yaml" target="_blank"> petstore.yaml</a>).
You should define a OpenAPI specification (example <a href="https://github.com/orval-labs/orval/blob/master/samples/basic/petstore.yaml" target="_blank"> petstore.yaml</a>).

And then create a file `orval.config.js` at root of your project:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/guides/custom-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ export type ErrorType<Error> = AxiosError<Error>;
export type BodyType<BodyData> = CamelCase<BodyType>;
```

Or, Please refer to the using custom fetch with Next.js sample app [here](https://github.com/anymaniax/orval/blob/master/samples/next-app-with-fetch/custom-fetch.ts).
Or, Please refer to the using custom fetch with Next.js sample app [here](https://github.com/orval-labs/orval/blob/master/samples/next-app-with-fetch/custom-fetch.ts).
6 changes: 3 additions & 3 deletions docs/src/pages/guides/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export default defineConfig({
```

Checkout the [orval config](../reference/configuration/full-example) reference to see all available options.
Like the following example from this <a href="https://github.com/anymaniax/orval/blob/master/samples/next-app-with-fetch/petstore.yaml" target="_blank">`OpenAPI` Specification</a>:
Like the following example from this <a href="https://github.com/orval-labs/orval/blob/master/samples/next-app-with-fetch/petstore.yaml" target="_blank">`OpenAPI` Specification</a>:

```ts
/**
Expand Down Expand Up @@ -75,7 +75,7 @@ The `fetch` client will generate an implementation file with following per path
2. A Function to generate request URL including query parameters and path parameters
3. A function that call `fetch` API.

Checkout <a href="https://github.com/anymaniax/orval/blob/master/samples/next-app-with-fetch" target="_blank">here</a> the full example
Checkout <a href="https://github.com/orval-labs/orval/blob/master/samples/next-app-with-fetch" target="_blank">here</a> the full example

#### Custom function

Expand All @@ -98,7 +98,7 @@ module.exports = {
};
```

And, you prepare like the <a href="https://github.com/anymaniax/orval/blob/master/samples/next-app-with-fetch/custom-fetch.ts" target="_blank">sample implementation</a>
And, you prepare like the <a href="https://github.com/orval-labs/orval/blob/master/samples/next-app-with-fetch/custom-fetch.ts" target="_blank">sample implementation</a>
Then, you can generate a `fetch` client that calls the `customFetch` function like bellow:

```ts
Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/guides/react-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Checkout the [orval config](../reference/configuration/full-example) reference t

The React query model will generate an implementation file with one custom hook per path in your OpenAPI Specification.

Like the following example from this <a href="https://github.com/anymaniax/orval/blob/master/samples/react-query/basic/petstore.yaml" target="_blank">swagger</a>:
Like the following example from this <a href="https://github.com/orval-labs/orval/blob/master/samples/react-query/basic/petstore.yaml" target="_blank">swagger</a>:

```ts
export const showPetById = (
Expand Down Expand Up @@ -115,4 +115,4 @@ module.exports = {
};
```

Checkout <a href="https://github.com/anymaniax/orval/blob/master/samples/react-query/basic" target="_blank">here</a> the full example
Checkout <a href="https://github.com/orval-labs/orval/blob/master/samples/react-query/basic" target="_blank">here</a> the full example
2 changes: 1 addition & 1 deletion docs/src/pages/guides/set-base-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ export const customFetch = async <T>(
};
```

Please refer to the complete sample [here](https://github.com/anymaniax/orval/blob/master/samples/next-app-with-fetch/custom-fetch.ts)
Please refer to the complete sample [here](https://github.com/orval-labs/orval/blob/master/samples/next-app-with-fetch/custom-fetch.ts)

### Angular http client

Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/guides/svelte-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Checkout the [orval config](../reference/configuration/full-example) reference t

The svelte query model will generate an implementation file with one custom hook per path in your OpenAPI Specification.

Like the following example from this <a href="https://github.com/anymaniax/orval/blob/master/samples/svelte-query/petstore.yaml" target="_blank">swagger</a>:
Like the following example from this <a href="https://github.com/orval-labs/orval/blob/master/samples/svelte-query/petstore.yaml" target="_blank">swagger</a>:

```ts
export const showPetById = (
Expand Down Expand Up @@ -118,4 +118,4 @@ module.exports = {
};
```

Checkout <a href="https://github.com/anymaniax/orval/tree/master/samples/svelte-query" target="_blank">here</a> the full example
Checkout <a href="https://github.com/orval-labs/orval/tree/master/samples/svelte-query" target="_blank">here</a> the full example
4 changes: 2 additions & 2 deletions docs/src/pages/guides/swr.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Checkout the [orval config](../reference/configuration/full-example) reference t

The SWR model will generate an implementation file with one custom hook per path in your OpenAPI Specification.

Like the following example from this <a href="https://github.com/anymaniax/orval/blob/master/samples/react-app-with-swr/petstore.yaml" target="_blank">swagger</a>:
Like the following example from this <a href="https://github.com/orval-labs/orval/blob/master/samples/react-app-with-swr/petstore.yaml" target="_blank">swagger</a>:

```ts
export const showPetById = (
Expand Down Expand Up @@ -71,4 +71,4 @@ export const useShowPetById = <TError = Error>(
};
```

Checkout <a href="https://github.com/anymaniax/orval/blob/master/samples/react-app-with-swr" target="_blank">here</a> the full example
Checkout <a href="https://github.com/orval-labs/orval/blob/master/samples/react-app-with-swr" target="_blank">here</a> the full example
4 changes: 2 additions & 2 deletions docs/src/pages/guides/vue-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Checkout the [orval config](../reference/configuration/full-example) reference t

The Vue query model will generate an implementation file with one custom hook per path in your OpenAPI Specification.

Like the following example from this <a href="https://github.com/anymaniax/orval/blob/master/samples/vue-query/petstore.yaml" target="_blank">swagger</a>:
Like the following example from this <a href="https://github.com/orval-labs/orval/blob/master/samples/vue-query/petstore.yaml" target="_blank">swagger</a>:

```ts
export const showPetById = (
Expand Down Expand Up @@ -118,4 +118,4 @@ module.exports = {
};
```

Checkout <a href="https://github.com/anymaniax/orval/tree/master/samples/vue-query" target="_blank">here</a> the full example
Checkout <a href="https://github.com/orval-labs/orval/tree/master/samples/vue-query" target="_blank">here</a> the full example
4 changes: 2 additions & 2 deletions docs/src/pages/reference/configuration/input.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ module.exports = {
};
```

Example of transformer <a href="https://github.com/anymaniax/orval/blob/master/samples/basic/api/transformer/add-version.js" target="_blank">here</a>
Example of transformer <a href="https://github.com/orval-labs/orval/blob/master/samples/basic/api/transformer/add-version.js" target="_blank">here</a>

### filters

Expand Down Expand Up @@ -117,7 +117,7 @@ Type: `Object`.

Default Value: `{}`.

Orval convert Swagger 2.0 definitions into OpenAPI 3.0.x. You can use the converterOptions property to provide custom config for that. Check [here](https://github.com/anymaniax/orval/blob/next/src/types/swagger2openapi.d.ts#L10) available options.
Orval convert Swagger 2.0 definitions into OpenAPI 3.0.x. You can use the converterOptions property to provide custom config for that. Check [here](https://github.com/orval-labs/orval/blob/next/src/types/swagger2openapi.d.ts#L10) available options.

```js
module.exports = {
Expand Down
12 changes: 6 additions & 6 deletions docs/src/pages/reference/configuration/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ module.exports = {
};
```

if you want you can provide a function to extend or create you custom client generator and this function receive a [[GeneratorClients](https://github.com/anymaniax/orval/blob/master/packages/core/src/types.ts#L156)](https://github.com/anymaniax/orval/blob/master/packages/core/src/types.ts#L156) in argument and should return a [ClientGeneratorsBuilder](https://github.com/anymaniax/orval/blob/master/packages/core/src/types.ts#L652).
if you want you can provide a function to extend or create you custom client generator and this function receive a [[GeneratorClients](https://github.com/orval-labs/orval/blob/master/packages/core/src/types.ts#L156)](https://github.com/orval-labs/orval/blob/master/packages/core/src/types.ts#L156) in argument and should return a [ClientGeneratorsBuilder](https://github.com/orval-labs/orval/blob/master/packages/core/src/types.ts#L652).

### httpClient

Expand Down Expand Up @@ -330,7 +330,7 @@ module.exports = {
};
```

If you want you can provide a function to extend or create you custom mock generator and check [here](https://github.com/anymaniax/orval/blob/master/src/types/generator.ts#L132) the type.
If you want you can provide a function to extend or create you custom mock generator and check [here](https://github.com/orval-labs/orval/blob/master/src/types/generator.ts#L132) the type.

To discover all the available options, read below.

Expand Down Expand Up @@ -454,7 +454,7 @@ Type: `String` or `Function`.

Valid values: path or implementation of the transformer function.

This function is executed for each call when you generate and take in argument a <a href="https://github.com/anymaniax/orval/blob/master/packages/core/src/types.ts#L556" target="_blank">GeneratorVerbOptions</a> and should return a <a href="https://github.com/anymaniax/orval/blob/master/packages/core/src/types.ts#L556" target="_blank">GeneratorVerbOptions</a>
This function is executed for each call when you generate and take in argument a <a href="https://github.com/orval-labs/orval/blob/master/packages/core/src/types.ts#L556" target="_blank">GeneratorVerbOptions</a> and should return a <a href="https://github.com/orval-labs/orval/blob/master/packages/core/src/types.ts#L556" target="_blank">GeneratorVerbOptions</a>

```js
module.exports = {
Expand Down Expand Up @@ -1170,7 +1170,7 @@ module.exports = {

Type: `Object`.

Give you the possibility to put a value for a `format`. In your specification, if you put a `format: email` to a property Orval will automatically generate a random email for you. See the default available format <a href="https://github.com/anymaniax/orval/blob/master/packages/mock/src/faker/constants.ts" target="_blank">here</a>.
Give you the possibility to put a value for a `format`. In your specification, if you put a `format: email` to a property Orval will automatically generate a random email for you. See the default available format <a href="https://github.com/orval-labs/orval/blob/master/packages/mock/src/faker/constants.ts" target="_blank">here</a>.

```js
module.exports = {
Expand Down Expand Up @@ -1803,7 +1803,7 @@ Valid Values: `true` or `false`.
Default Value: `false`.

Applies to all clients, but probably only makes sense for `Tanstack Query`.
Use this property to make all parameters optional except the path parameter. This is useful to take advantage of the `Orval`'s auto-enable feature for `Tanstack Query`, see https://github.com/anymaniax/orval/pull/894
Use this property to make all parameters optional except the path parameter. This is useful to take advantage of the `Orval`'s auto-enable feature for `Tanstack Query`, see https://github.com/orval-labs/orval/pull/894

```js
module.exports = {
Expand All @@ -1821,7 +1821,7 @@ Type: `Boolean`

Valid values: true or false. Defaults to false. **Note:** this only works for Tanstack Query clients for now.

Use this property to enable URL encoding of path/query parameters. This is highly recommended, and will probably become a default in the future, see https://github.com/anymaniax/orval/pull/895
Use this property to enable URL encoding of path/query parameters. This is highly recommended, and will probably become a default in the future, see https://github.com/orval-labs/orval/pull/895

```js
module.exports = {
Expand Down
4 changes: 2 additions & 2 deletions docs/src/siteConfig.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// List of projects/orgs using your project for the users page.
export const siteConfig = {
editUrl: 'https://github.com/anymaniax/orval/edit/master/docs/src/pages',
editUrl: 'https://github.com/orval-labs/orval/edit/master/docs/src/pages',
copyright: `Copyright © ${new Date().getFullYear()} Victor Bury. All Rights Reserved.`,
repoUrl: 'https://github.com/anymaniax/orval',
repoUrl: 'https://github.com/orval-labs/orval',
discordUrl: 'https://discord.gg/6fC2sjDU7w',
algolia: {
appId: process.env.NEXT_PUBLIC_ALGOLIA_APP_ID,
Expand Down
Loading

0 comments on commit 7967aaf

Please sign in to comment.