refactor: APIエンドポイントファイルの定義を良い感じにする (#8154)

* Fix API Schema Error

* Delete SimpleSchema/SimpleObj
and Move schemas to dedicated files

* Userのスキーマを分割してみる

* define packMany type

* add ,

* Ensure enum schema and Make "as const" put once

* test?

* Revert "test?"

This reverts commit 97dc9bfa70851bfb7d1cf38e883f8df20fb78b79.

* Revert "Fix API Schema Error"

This reverts commit 21b6176d974ed8e3eb73723ad21a105c5d297323.

* ✌️

* clean up

* test?

* wip

* wip

* better schema def

* ✌️

* fix

* add minLength property

* wip

* wip

* wip

* anyOf/oneOf/allOfに対応? ~ relation.ts

* refactor!

* Define MinimumSchema

* wip

* wip

* anyOf/oneOf/allOfが動作するようにUnionSchemaTypeを修正

* anyOf/oneOf/allOfが動作するようにUnionSchemaTypeを修正

* Update packages/backend/src/misc/schema.ts

Co-authored-by: Acid Chicken (硫酸鶏) <root@acid-chicken.com>

* fix

* array oneOfをより正確な型に

* array oneOfをより正確な型に

* wip

* ✌️

* なんかもういろいろ

* remove

* very good schema

* api schema

* wip

* refactor: awaitAllの型定義を変えてみる

* fix

* specify types in awaitAll

* specify types in awaitAll

* ✌️

* wip

* ...

* ✌️

* AllowDateはやめておく

* 不必要なoptional: false, nullable: falseを廃止

* Packedが展開されないように

* 続packed

* wip

* define note type

* wip

* UserDetailedをMeDetailedかUserDetailedNotMeかを区別できるように

* wip

* wip

* wip specify user type of other schemas

* ok

* convertSchemaToOpenApiSchemaを改修

* convertSchemaToOpenApiSchemaを改修

* Fix

* fix

* ✌️

* wip

* 分割代入ではなくallOfで定義するように

Co-authored-by: Acid Chicken (硫酸鶏) <root@acid-chicken.com>
This commit is contained in:
tamaina 2022-01-18 22:27:10 +09:00 committed by GitHub
parent a8fad1b61c
commit efb0ffc4ec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
358 changed files with 3623 additions and 3417 deletions

View file

@ -3,7 +3,7 @@ import { dirname } from 'path';
import { Context } from 'cafy';
import * as path from 'path';
import * as glob from 'glob';
import { SimpleSchema } from '@/misc/simple-schema';
import { Schema } from '@/misc/schema';
//const _filename = fileURLToPath(import.meta.url);
const _filename = __filename;
@ -18,87 +18,87 @@ export type Param = {
};
export interface IEndpointMeta {
stability?: string; //'deprecated' | 'experimental' | 'stable';
readonly stability?: 'deprecated' | 'experimental' | 'stable';
tags?: string[];
readonly tags?: ReadonlyArray<string>;
params?: {
[key: string]: Param;
readonly params?: {
readonly [key: string]: Param;
};
errors?: {
[key: string]: {
message: string;
code: string;
id: string;
readonly errors?: {
readonly [key: string]: {
readonly message: string;
readonly code: string;
readonly id: string;
};
};
res?: SimpleSchema;
readonly res?: Schema;
/**
*
* false
*/
requireCredential?: boolean;
readonly requireCredential?: boolean;
/**
* 使
*/
requireAdmin?: boolean;
readonly requireAdmin?: boolean;
/**
* 使
*/
requireModerator?: boolean;
readonly requireModerator?: boolean;
/**
*
*
* withCredential false
*/
limit?: {
readonly limit?: {
/**
*
*/
key?: string;
readonly key?: string;
/**
* (ms)
* max
*/
duration?: number;
readonly duration?: number;
/**
* durationで指定した期間内にいくつまでリクエストできるのか
* duration
*/
max?: number;
readonly max?: number;
/**
* (ms)
*/
minInterval?: number;
readonly minInterval?: number;
};
/**
*
* false
*/
requireFile?: boolean;
readonly requireFile?: boolean;
/**
*
* false
*/
secure?: boolean;
readonly secure?: boolean;
/**
*
*
*/
kind?: string;
readonly kind?: string;
}
export interface IEndpoint {