fork of hey-api/openapi-ts because I need some additional things
Merge pull request #347 from hey-api/docs/contributing
Docs/contributing
+42
-20
+5
.changeset/empty-ducks-smell.md
+5
.changeset/empty-ducks-smell.md
+7
-7
docs/.vitepress/config/en.ts
+7
-7
docs/.vitepress/config/en.ts
···
6
6
themeConfig: {
7
7
sidebar: [
8
8
{
9
-
text: '@hey-api',
10
-
items: [
11
-
{ text: 'Hey 👋', link: '/welcome' },
12
-
{ text: 'Contributing', link: '/contributing' },
13
-
],
14
-
},
15
-
{
16
9
text: 'openapi-ts',
17
10
items: [
18
11
{ text: 'Get Started', link: '/openapi-ts/get-started' },
19
12
{ text: 'Configuration', link: '/openapi-ts/configuration' },
20
13
{ text: 'Interceptors', link: '/openapi-ts/interceptors' },
21
14
{ text: 'Migrating', link: '/openapi-ts/migrating' },
15
+
],
16
+
},
17
+
{
18
+
text: '@hey-api',
19
+
items: [
20
+
{ text: 'About', link: '/about' },
21
+
{ text: 'Contributing', link: '/contributing' },
22
22
],
23
23
},
24
24
],
+1
-1
docs/contributing.md
+1
-1
docs/contributing.md
···
5
5
6
6
# Contributing
7
7
8
-
Thank you for considering contributing to Hey API.
8
+
Thank you for considering contributing to Hey API. In order to increase the likelihood of your changes being merged, first open an issue if one does not already exist. Once an issue exists, let us know you'd like to work on it. We will confirm whether we're looking to resolve the issue and provide you with guidance if required. This is to ensure our codebase remains in good state and all features contribute to Hey API's [objectives](/about).
9
9
10
10
## Development Requirements
11
11
+1
-1
docs/index.md
+1
-1
docs/index.md
+1
-1
docs/openapi-ts/configuration.md
+1
-1
docs/openapi-ts/configuration.md
···
155
155
By default, `openapi-ts` exports schemas from your OpenAPI specification as plain JavaScript objects. A great use case for schemas is client-side form input validation.
156
156
157
157
```ts
158
-
import { $Schema } from 'src/client'
158
+
import { $Schema } from 'client/schemas'
159
159
160
160
const maxInputLength = $Schema.properties.text.maxLength
161
161
+25
-8
docs/openapi-ts/migrating.md
+25
-8
docs/openapi-ts/migrating.md
···
11
11
12
12
These changes haven't been released yet. However, you can migrate your code today to save time on migration once they're released.
13
13
14
+
### Deprecated exports from `index.ts`
15
+
16
+
Currently, `index.ts` file exports all generated artifacts.
17
+
18
+
```ts
19
+
export { ApiError } from './core/ApiError';
20
+
export { CancelablePromise, CancelError } from './core/CancelablePromise';
21
+
export { OpenAPI, type OpenAPIConfig } from './core/OpenAPI';
22
+
export * from './models';
23
+
export * from './schemas';
24
+
export * from './services';
25
+
```
26
+
27
+
We will be slowly moving away from this practice. Any non-core related imports should be imported as
28
+
29
+
```ts
30
+
import type { Model } from 'client/models';
31
+
import { $Schema } from 'client/schemas';
32
+
import { DefaultService } from 'client/services';
33
+
```
34
+
35
+
You don't have to update imports from `core` directory. These will be addressed in later releases.
36
+
14
37
### Deprecated `useOptions`
15
38
16
39
This config option is deprecated and will be removed.
···
78
101
By default, generated clients will use a single object argument to pass values to API calls. This is a significant change from the previous default of unspecified array of arguments. If migrating your application in one go isn't feasible, we recommend deprecating your old client and generating a new client.
79
102
80
103
```ts
81
-
import { DefaultService } from 'client' // <-- old client with array arguments
104
+
import { DefaultService } from 'client/services' // <-- old client with array arguments
82
105
83
-
import { DefaultService } from 'client_v2' // <-- new client with options argument
106
+
import { DefaultService } from 'client_v2/services' // <-- new client with options argument
84
107
```
85
108
86
109
This way, you can gradually switch over to the new syntax as you update parts of your code. Once you've removed all instances of `client` imports, you can safely delete the old `client` folder and find and replace all `client_v2` calls to `client`.
···
129
152
- `useUnionTypes` has been removed (see [v0.27.24](#v0-27-24))
130
153
- `indent` has been removed (see [v0.27.26](#v0-27-26))
131
154
- `postfixModels` has been removed (see [v0.35.0](#v0-35-0))
132
-
133
-
### Deprecated
134
-
135
-
- `postfixServices` is deprecated (see [@next](#next))
136
-
- `request` is deprecated (see [@next](#next))
137
-
- `name` is deprecated (see [@next](#next))
+2
-2
docs/welcome.md
docs/about.md
+2
-2
docs/welcome.md
docs/about.md
···
1
1
---
2
-
title: Hey 👋
2
+
title: About
3
3
description: Hello from Hey API.
4
4
---
5
5
6
-
# Hey 👋
6
+
# About Hey API
7
7
8
8
Hey API's objective is to provide a set of TypeScript tools to manage API interactions. Whether you're building a front-end application, API-to-API service, or micro-frontends, we want Hey API to be your go-to resource.
9
9