瀏覽代碼

fix api docs

master
Daniel 1 年之前
父節點
當前提交
62f0d45228
共有 21 個文件被更改,包括 61 次插入110 次删除
  1. +1
    -1
      angular/openapi.json
  2. +24
    -72
      angular/openapi.yaml
  3. +0
    -1
      angular/src/app/core/api/v1/.openapi-generator/FILES
  4. +2
    -2
      angular/src/app/core/api/v1/model/trip.ts
  5. +2
    -2
      angular/src/app/core/api/v1/model/tripJsonld.ts
  6. +1
    -1
      angular/src/app/core/api/v1/model/tripLocation.ts
  7. +1
    -1
      angular/src/app/core/api/v1/model/tripLocationJsonld.ts
  8. +4
    -4
      angular/src/app/core/api/v1/model/user.ts
  9. +4
    -4
      angular/src/app/core/api/v1/model/userJsonld.ts
  10. +2
    -2
      angular/src/app/core/api/v1/model/userTrip.ts
  11. +2
    -2
      angular/src/app/core/api/v1/model/userTripJsonld.ts
  12. +1
    -1
      angular/src/app/core/api/v1/model/userTripLocation.ts
  13. +1
    -1
      angular/src/app/core/api/v1/model/userTripLocationJsonld.ts
  14. +2
    -2
      angular/src/app/core/api/v1/model/userTripWorkLog.ts
  15. +2
    -2
      angular/src/app/core/api/v1/model/userTripWorkLogJsonld.ts
  16. +2
    -2
      httpdocs/src/ApiResource/TripApi.php
  17. +1
    -1
      httpdocs/src/ApiResource/TripLocationApi.php
  18. +4
    -4
      httpdocs/src/ApiResource/UserApi.php
  19. +2
    -2
      httpdocs/src/ApiResource/UserTripApi.php
  20. +1
    -1
      httpdocs/src/ApiResource/UserTripLocationApi.php
  21. +2
    -2
      httpdocs/src/ApiResource/UserTripWorkLogApi.php

+ 1
- 1
angular/openapi.json
文件差異過大導致無法顯示
查看文件


+ 24
- 72
angular/openapi.yaml 查看文件

@@ -2199,14 +2199,10 @@ components:
format: iri-reference
example: 'https://example.com/'
startDate:
type:
- string
- 'null'
type: string
format: date-time
endDate:
type:
- string
- 'null'
type: string
format: date-time
createdAt:
readOnly: true
@@ -2267,14 +2263,10 @@ components:
readOnly: true
$ref: '#/components/schemas/Location.jsonld'
startDate:
type:
- string
- 'null'
type: string
format: date-time
endDate:
type:
- string
- 'null'
type: string
format: date-time
createdAt:
readOnly: true
@@ -2307,9 +2299,7 @@ components:
format: iri-reference
example: 'https://example.com/'
date:
type:
- string
- 'null'
type: string
format: date-time
createdAt:
readOnly: true
@@ -2359,9 +2349,7 @@ components:
readOnly: true
$ref: '#/components/schemas/Location.jsonld'
date:
type:
- string
- 'null'
type: string
format: date-time
createdAt:
readOnly: true
@@ -2385,17 +2373,11 @@ components:
format: email
externalDocs:
url: 'https://schema.org/email'
type:
- string
- 'null'
type: string
firstName:
type:
- string
- 'null'
type: string
lastName:
type:
- string
- 'null'
type: string
image:
type:
- string
@@ -2415,9 +2397,7 @@ components:
password:
writeOnly: true
description: 'The plaintext password when being set or changed.'
type:
- string
- 'null'
type: string
active:
type: boolean
createdAt:
@@ -2467,17 +2447,11 @@ components:
format: email
externalDocs:
url: 'https://schema.org/email'
type:
- string
- 'null'
type: string
firstName:
type:
- string
- 'null'
type: string
lastName:
type:
- string
- 'null'
type: string
image:
type:
- string
@@ -2497,9 +2471,7 @@ components:
password:
writeOnly: true
description: 'The plaintext password when being set or changed.'
type:
- string
- 'null'
type: string
active:
type: boolean
createdAt:
@@ -2535,14 +2507,10 @@ components:
captainName:
type: string
startDate:
type:
- string
- 'null'
type: string
format: date-time
endDate:
type:
- string
- 'null'
type: string
format: date-time
createdAt:
readOnly: true
@@ -2596,14 +2564,10 @@ components:
captainName:
type: string
startDate:
type:
- string
- 'null'
type: string
format: date-time
endDate:
type:
- string
- 'null'
type: string
format: date-time
createdAt:
readOnly: true
@@ -2636,9 +2600,7 @@ components:
format: iri-reference
example: 'https://example.com/'
plannedDate:
type:
- string
- 'null'
type: string
format: date-time
createdAt:
readOnly: true
@@ -2688,9 +2650,7 @@ components:
readOnly: true
$ref: '#/components/schemas/Location.jsonld'
plannedDate:
type:
- string
- 'null'
type: string
format: date-time
createdAt:
readOnly: true
@@ -2726,14 +2686,10 @@ components:
format: iri-reference
example: 'https://example.com/'
startDate:
type:
- string
- 'null'
type: string
format: date-time
endDate:
type:
- string
- 'null'
type: string
format: date-time
createdAt:
readOnly: true
@@ -2787,14 +2743,10 @@ components:
readOnly: true
$ref: '#/components/schemas/Location.jsonld'
startDate:
type:
- string
- 'null'
type: string
format: date-time
endDate:
type:
- string
- 'null'
type: string
format: date-time
createdAt:
readOnly: true


+ 0
- 1
angular/src/app/core/api/v1/.openapi-generator/FILES 查看文件

@@ -1,5 +1,4 @@
.gitignore
.openapi-generator-ignore
README.md
api.module.ts
api/api.ts


+ 2
- 2
angular/src/app/core/api/v1/model/trip.ts 查看文件

@@ -21,8 +21,8 @@ export interface Trip {
captainName?: string | null;
readonly startLocation?: string;
readonly endLocation?: string;
startDate: string | null;
endDate: string | null;
startDate: string;
endDate: string;
readonly createdAt?: string | null;
}


+ 2
- 2
angular/src/app/core/api/v1/model/tripJsonld.ts 查看文件

@@ -27,8 +27,8 @@ export interface TripJsonld {
captainName?: string | null;
readonly startLocation?: LocationJsonld;
readonly endLocation?: LocationJsonld;
startDate: string | null;
endDate: string | null;
startDate: string;
endDate: string;
readonly createdAt?: string | null;
}


+ 1
- 1
angular/src/app/core/api/v1/model/tripLocation.ts 查看文件

@@ -18,7 +18,7 @@ export interface TripLocation {
readonly dbId?: number | null;
readonly trip?: string;
readonly location?: string;
date: string | null;
date: string;
readonly createdAt?: string | null;
}


+ 1
- 1
angular/src/app/core/api/v1/model/tripLocationJsonld.ts 查看文件

@@ -24,7 +24,7 @@ export interface TripLocationJsonld {
readonly dbId?: number | null;
readonly trip?: TripJsonld;
readonly location?: LocationJsonld;
date: string | null;
date: string;
readonly createdAt?: string | null;
}


+ 4
- 4
angular/src/app/core/api/v1/model/user.ts 查看文件

@@ -16,16 +16,16 @@
*/
export interface User {
readonly dbId?: number | null;
email: string | null;
firstName: string | null;
lastName: string | null;
email: string;
firstName: string;
lastName: string;
image?: string | null;
readonly imageUrl?: string | null;
readonly fullName?: string | null;
/**
* The plaintext password when being set or changed.
*/
password?: string | null;
password?: string;
active?: boolean;
readonly createdAt?: string | null;
}


+ 4
- 4
angular/src/app/core/api/v1/model/userJsonld.ts 查看文件

@@ -20,16 +20,16 @@ export interface UserJsonld {
readonly id?: string;
readonly type?: string;
readonly dbId?: number | null;
email: string | null;
firstName: string | null;
lastName: string | null;
email: string;
firstName: string;
lastName: string;
image?: string | null;
readonly imageUrl?: string | null;
readonly fullName?: string | null;
/**
* The plaintext password when being set or changed.
*/
password?: string | null;
password?: string;
active?: boolean;
readonly createdAt?: string | null;
}


+ 2
- 2
angular/src/app/core/api/v1/model/userTrip.ts 查看文件

@@ -19,8 +19,8 @@ export interface UserTrip {
readonly trip?: string;
readonly user?: string;
captainName: string;
startDate: string | null;
endDate: string | null;
startDate: string;
endDate: string;
readonly createdAt?: string | null;
}


+ 2
- 2
angular/src/app/core/api/v1/model/userTripJsonld.ts 查看文件

@@ -25,8 +25,8 @@ export interface UserTripJsonld {
readonly trip?: TripJsonld;
readonly user?: UserJsonld;
captainName: string;
startDate: string | null;
endDate: string | null;
startDate: string;
endDate: string;
readonly createdAt?: string | null;
}


+ 1
- 1
angular/src/app/core/api/v1/model/userTripLocation.ts 查看文件

@@ -18,7 +18,7 @@ export interface UserTripLocation {
readonly dbId?: number | null;
readonly userTrip?: string;
readonly location?: string;
plannedDate: string | null;
plannedDate: string;
readonly createdAt?: string | null;
}


+ 1
- 1
angular/src/app/core/api/v1/model/userTripLocationJsonld.ts 查看文件

@@ -24,7 +24,7 @@ export interface UserTripLocationJsonld {
readonly dbId?: number | null;
readonly userTrip?: UserTripJsonld;
readonly location?: LocationJsonld;
plannedDate: string | null;
plannedDate: string;
readonly createdAt?: string | null;
}


+ 2
- 2
angular/src/app/core/api/v1/model/userTripWorkLog.ts 查看文件

@@ -19,8 +19,8 @@ export interface UserTripWorkLog {
readonly userTrip?: string;
readonly startLocation?: string;
readonly endLocation?: string;
startDate: string | null;
endDate: string | null;
startDate: string;
endDate: string;
readonly createdAt?: string | null;
}


+ 2
- 2
angular/src/app/core/api/v1/model/userTripWorkLogJsonld.ts 查看文件

@@ -25,8 +25,8 @@ export interface UserTripWorkLogJsonld {
readonly userTrip?: UserTripJsonld;
readonly startLocation?: LocationJsonld;
readonly endLocation?: LocationJsonld;
startDate: string | null;
endDate: string | null;
startDate: string;
endDate: string;
readonly createdAt?: string | null;
}


+ 2
- 2
httpdocs/src/ApiResource/TripApi.php 查看文件

@@ -98,10 +98,10 @@ class TripApi
public ?LocationApi $endLocation = null;

#[Assert\NotBlank]
public ?\DateTimeImmutable $startDate = null;
public \DateTimeImmutable $startDate;

#[Assert\NotBlank]
public ?\DateTimeImmutable $endDate = null;
public \DateTimeImmutable $endDate;

#[ApiProperty(writable: false)]
public ?\DateTimeImmutable $createdAt = null;

+ 1
- 1
httpdocs/src/ApiResource/TripLocationApi.php 查看文件

@@ -77,7 +77,7 @@ class TripLocationApi
public ?LocationApi $location = null;

#[Assert\NotBlank]
public ?\DateTimeImmutable $date = null;
public \DateTimeImmutable $date;

#[ApiProperty(writable: false)]
public ?\DateTimeImmutable $createdAt = null;

+ 4
- 4
httpdocs/src/ApiResource/UserApi.php 查看文件

@@ -64,13 +64,13 @@ class UserApi

#[Assert\NotBlank]
#[Assert\Email]
public ?string $email = null;
public string $email;

#[Assert\NotBlank]
public ?string $firstName = null;
public string $firstName;

#[Assert\NotBlank]
public ?string $lastName = null;
public string $lastName;

public ?MediaObject $image = null;

@@ -85,7 +85,7 @@ class UserApi
*/
#[ApiProperty(readable: false)]
#[Assert\NotBlank(groups: ['postValidation'])]
public ?string $password = null;
public string $password;

// Object is null ONLY during deserialization: so this allows isPublished
// to be writable in ALL cases (which is ok because the operations are secured).


+ 2
- 2
httpdocs/src/ApiResource/UserTripApi.php 查看文件

@@ -80,10 +80,10 @@ class UserTripApi
public string $captainName;

#[Assert\NotBlank]
public ?\DateTimeImmutable $startDate = null;
public \DateTimeImmutable $startDate;

#[Assert\NotBlank]
public ?\DateTimeImmutable $endDate = null;
public \DateTimeImmutable $endDate;

#[ApiProperty(writable: false)]
public ?\DateTimeImmutable $createdAt = null;

+ 1
- 1
httpdocs/src/ApiResource/UserTripLocationApi.php 查看文件

@@ -77,7 +77,7 @@ class UserTripLocationApi
public ?LocationApi $location = null;

#[Assert\NotBlank]
public ?\DateTimeImmutable $plannedDate = null;
public \DateTimeImmutable $plannedDate;

#[ApiProperty(writable: false)]
public ?\DateTimeImmutable $createdAt = null;

+ 2
- 2
httpdocs/src/ApiResource/UserTripWorkLogApi.php 查看文件

@@ -93,10 +93,10 @@ class UserTripWorkLogApi
public ?LocationApi $endLocation = null;

#[Assert\NotBlank]
public ?\DateTimeImmutable $startDate = null;
public \DateTimeImmutable $startDate;

#[Assert\NotBlank]
public ?\DateTimeImmutable $endDate = null;
public \DateTimeImmutable $endDate;

#[ApiProperty(writable: false)]
public ?\DateTimeImmutable $createdAt = null;

Loading…
取消
儲存