Skip to content

Commit 6789395

Browse files
Fix | Documentation build (#471)
* feat: Extend Swagger Coverage for controller `OAuth2SummitDocumentsApiController` * chore: Add the correct security and x attributes and create security schema * fix: merge issues --------- Co-authored-by: Matias Perrone <[email protected]>
1 parent 5878c5a commit 6789395

File tree

1 file changed

+0
-98
lines changed

1 file changed

+0
-98
lines changed

app/Swagger/SummitSchemas.php

Lines changed: 0 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -292,104 +292,6 @@ class SummitDocumentCreateRequest {}
292292
)]
293293
class SummitDocumentUpdateRequest {}
294294

295-
// Summit Documents
296-
297-
#[OA\Schema(
298-
schema: "SummitDocument",
299-
description: "Summit document",
300-
type: "object",
301-
properties: [
302-
new OA\Property(property: "id", type: "integer", example: 1),
303-
new OA\Property(property: "created", type: "integer", description: "Unix timestamp", example: 1640995200),
304-
new OA\Property(property: "last_edited", type: "integer", description: "Unix timestamp", example: 1640995200),
305-
new OA\Property(property: "name", type: "string", example: "Code of Conduct"),
306-
new OA\Property(property: "description", type: "string", example: "Summit code of conduct document"),
307-
new OA\Property(property: "show_always", type: "boolean", example: true),
308-
new OA\Property(property: "label", type: "string", example: "Code of Conduct"),
309-
new OA\Property(property: "file", type: "string", format: "uri", nullable: true, example: "https://example.com/document.pdf"),
310-
new OA\Property(property: "web_link", type: "string", format: "uri", nullable: true, example: "https://example.com/page"),
311-
new OA\Property(property: "selection_plan_id", type: "integer", nullable: true, description: "SelectionPlan ID, full object description when ?expand=summit (summit)"),
312-
new OA\Property(
313-
property: "event_types",
314-
type: "array",
315-
items: new OA\Items(type: "integer"),
316-
description: "Array of SummitEventType: objects when expanded, ids otherwise",
317-
),
318-
new OA\Property(property: "summit_id", type: "integer", description: "Summit ID, full object description when ?expand=summit (summit)"),
319-
]
320-
)]
321-
class SummitDocumentSchema {}
322-
323-
#[OA\Schema(
324-
schema: "PaginatedSummitDocumentsResponse",
325-
description: "Paginated list of summit documents",
326-
allOf: [
327-
new OA\Schema(ref: "#/components/schemas/PaginateDataSchemaResponse"),
328-
new OA\Schema(
329-
properties: [
330-
new OA\Property(
331-
property: "data",
332-
type: "array",
333-
items: new OA\Items(ref: "#/components/schemas/SummitDocument")
334-
)
335-
]
336-
)
337-
]
338-
)]
339-
class PaginatedSummitDocumentsResponseSchema {}
340-
341-
#[OA\Schema(
342-
schema: "SummitDocumentCreateRequest",
343-
description: "Request to create a summit document",
344-
required: ["name", "label"],
345-
type: "object",
346-
properties: [
347-
new OA\Property(property: "name", type: "string", example: "Code of Conduct"),
348-
new OA\Property(property: "label", type: "string", example: "Code of Conduct"),
349-
new OA\Property(property: "description", type: "string", nullable: true, example: "Summit code of conduct document"),
350-
new OA\Property(property: "show_always", type: "boolean", nullable: true, example: true),
351-
new OA\Property(property: "web_link", type: "string", format: "uri", nullable: true, example: "https://example.com/page"),
352-
new OA\Property(property: "selection_plan_id", type: "integer", nullable: true, example: 1),
353-
new OA\Property(
354-
property: "event_types",
355-
type: "array",
356-
nullable: true,
357-
items: new OA\Items(type: "integer"),
358-
example: [1, 2, 3]
359-
),
360-
new OA\Property(
361-
property: "file",
362-
type: "string",
363-
format: "binary",
364-
nullable: true,
365-
description: "Document file upload (required if web_link not provided)"
366-
),
367-
]
368-
)]
369-
class SummitDocumentCreateRequest {}
370-
371-
#[OA\Schema(
372-
schema: "SummitDocumentUpdateRequest",
373-
description: "Request to update a summit document",
374-
type: "object",
375-
properties: [
376-
new OA\Property(property: "name", type: "string", nullable: true, example: "Code of Conduct"),
377-
new OA\Property(property: "label", type: "string", nullable: true, example: "Code of Conduct"),
378-
new OA\Property(property: "description", type: "string", nullable: true, example: "Summit code of conduct document"),
379-
new OA\Property(property: "show_always", type: "boolean", nullable: true, example: true),
380-
new OA\Property(property: "web_link", type: "string", format: "uri", nullable: true, example: "https://example.com/page"),
381-
new OA\Property(property: "selection_plan_id", type: "integer", nullable: true, example: 1),
382-
new OA\Property(
383-
property: "event_types",
384-
type: "array",
385-
nullable: true,
386-
items: new OA\Items(type: "integer"),
387-
example: [1, 2, 3]
388-
),
389-
]
390-
)]
391-
class SummitDocumentUpdateRequest {}
392-
393295
// Summit Attendee Badges
394296

395297
#[OA\Schema(

0 commit comments

Comments
 (0)