{ "openapi": "3.1.1", "info": { "title": "OneYaad.Api | v1", "version": "1.0.0" }, "servers": [ { "url": "https://api.oneyaad.ca/" } ], "paths": { "/api/v1/one-ee/chat": { "post": { "tags": [ "One-ee" ], "summary": "Chat with the One-ee AI community assistant", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OneEeChatRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/donations/checkout": { "post": { "tags": [ "Donations" ], "summary": "Create a hosted Stripe Checkout Session for a community donation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDonationCheckoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/cities": { "get": { "tags": [ "OneYaadEndpoints" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/feature-flags": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "cityId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/contact-information": { "get": { "tags": [ "OneYaadEndpoints" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/contact-messages": { "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactMessageRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/organizations": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "cityId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/resource-categories": { "get": { "tags": [ "OneYaadEndpoints" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/resources": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "cityId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateResourceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/resources/{id}/main-image": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/events": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "cityId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEventRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/events/{id}/poster": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/community-summary": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "cityId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/needs": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "cityId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNeedRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/offers": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "cityId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOfferRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/offers/{id}": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cityId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOfferRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/offers/{id}/owner-reviews": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cityId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/offers/{id}/owner-avatar": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cityId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/offers/{id}/owner-images/{imageId}": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "imageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cityId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/register": { "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/token": { "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignInRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/refresh": { "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/logout": { "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/me": { "get": { "tags": [ "OneYaadEndpoints" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/me/media": { "get": { "tags": [ "OneYaadEndpoints" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/me/avatar": { "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "image" ], "type": "object", "properties": { "image": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/me/avatar/content": { "get": { "tags": [ "OneYaadEndpoints" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/me/offer-images": { "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "image" ], "type": "object", "properties": { "image": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/me/offer-images/{id}/content": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/me/offer-images/{id}": { "delete": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/organizations/{id}": { "patch": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/organizations/{id}/verification": { "put": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyOrganizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/organizations/{id}/members": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertOrganizationMemberRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/resources/{id}/images": { "post": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "image" ], "type": "object", "properties": { "image": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/resources/{id}": { "patch": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResourceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/resources/{id}/verification": { "put": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyResourceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/needs/{id}": { "patch": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNeedRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/introductions": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIntroductionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/introductions/{id}/requester-avatar": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/introductions/{id}/requester-images": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/introductions/{id}/requester-images/{imageId}": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "imageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/introductions/{id}/consent": { "put": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordConsentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/introductions/{id}/complete": { "put": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteIntroductionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/introductions/{id}/contacts": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertIntroductionContactRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/introductions/{id}/messages": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendIntroductionMessageRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/introductions/{id}/messages/read": { "put": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/events/{id}/rsvp": { "put": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RsvpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/donations": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/contributions": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContributionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/reports": { "get": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "OneYaadEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/reports/{id}/moderate": { "put": { "tags": [ "OneYaadEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModerateReportRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/resources": { "get": { "tags": [ "AdminContentEndpoints" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AdminContentEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminResourceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/resources/{id}": { "put": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminResourceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/resource-categories": { "get": { "tags": [ "AdminContentEndpoints" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AdminContentEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceCategoryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/resource-categories/{id}": { "put": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceCategoryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/resources/{id}/images": { "post": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "image" ], "type": "object", "properties": { "image": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/resources/{id}/images/{imageId}/content": { "get": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "imageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/resources/{id}/images/{imageId}/main": { "put": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "imageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/resources/{id}/images/{imageId}": { "delete": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "imageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/events": { "get": { "tags": [ "AdminContentEndpoints" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AdminContentEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminEventRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/events/{id}": { "put": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminEventRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/users": { "get": { "tags": [ "AdminContentEndpoints" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AdminContentEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/users/{id}": { "delete": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/contact-information": { "get": { "tags": [ "AdminContentEndpoints" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "AdminContentEndpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactInformationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/contact-information/{id}": { "put": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactInformationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/contact-messages": { "get": { "tags": [ "AdminContentEndpoints" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/contact-messages/{id}/status": { "put": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContactMessageStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/contact-messages/{id}": { "delete": { "tags": [ "AdminContentEndpoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AdminEventRequest": { "required": [ "cityId", "title", "description", "startsAt", "endsAt", "locationName", "registrationUrl", "capacity", "status" ], "type": "object", "properties": { "cityId": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "startsAt": { "type": "string", "format": "date-time" }, "endsAt": { "type": "string", "format": "date-time" }, "locationName": { "type": [ "null", "string" ] }, "registrationUrl": { "type": [ "null", "string" ] }, "capacity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "status": { "type": "string" }, "isPromoted": { "type": "boolean", "default": false } } }, "AdminResourceRequest": { "required": [ "cityId", "title", "summary", "category", "websiteUrl", "phone", "addressText", "status", "verificationStatus", "isAuthoritative", "verificationExpiresAt" ], "type": "object", "properties": { "cityId": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "summary": { "type": "string" }, "category": { "type": "string" }, "websiteUrl": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "addressText": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "verificationStatus": { "type": "string" }, "isAuthoritative": { "type": "boolean" }, "verificationExpiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "isPromoted": { "type": "boolean", "default": false } } }, "AdminUserRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "CompleteIntroductionRequest": { "required": [ "usefulnessScore", "reviewComment" ], "type": "object", "properties": { "usefulnessScore": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int16" }, "reviewComment": { "type": "string" } } }, "ContactInformationRequest": { "required": [ "label", "email", "phone", "addressText", "officeHours", "websiteUrl", "isActive", "displayOrder" ], "type": "object", "properties": { "label": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "addressText": { "type": [ "null", "string" ] }, "officeHours": { "type": [ "null", "string" ] }, "websiteUrl": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "CreateContactMessageRequest": { "required": [ "senderName", "senderEmail", "subject", "body" ], "type": "object", "properties": { "senderName": { "type": "string" }, "senderEmail": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" } } }, "CreateContributionRequest": { "required": [ "cityId", "contributionType", "entityType", "entityId", "occurredAt", "notes" ], "type": "object", "properties": { "cityId": { "type": [ "null", "string" ], "format": "uuid" }, "contributionType": { "type": "string" }, "entityType": { "type": [ "null", "string" ] }, "entityId": { "type": [ "null", "string" ], "format": "uuid" }, "occurredAt": { "type": [ "null", "string" ], "format": "date-time" }, "notes": { "type": [ "null", "string" ] } } }, "CreateDonationCheckoutRequest": { "required": [ "amountMinor" ], "type": "object", "properties": { "amountMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "CreateEventRequest": { "required": [ "cityId", "organizationId", "title", "description", "startsAt", "endsAt", "locationName", "registrationUrl", "capacity" ], "type": "object", "properties": { "cityId": { "type": "string", "format": "uuid" }, "organizationId": { "type": [ "null", "string" ], "format": "uuid" }, "title": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "startsAt": { "type": "string", "format": "date-time" }, "endsAt": { "type": "string", "format": "date-time" }, "locationName": { "type": [ "null", "string" ] }, "registrationUrl": { "type": [ "null", "string" ] }, "capacity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "representativeContactConsent": { "type": "boolean", "default": false } } }, "CreateIntroductionRequest": { "required": [ "needId", "offerId", "helperId" ], "type": "object", "properties": { "needId": { "type": [ "null", "string" ], "format": "uuid" }, "offerId": { "type": [ "null", "string" ], "format": "uuid" }, "helperId": { "type": "string", "format": "uuid" }, "initialMessage": { "type": [ "null", "string" ] } } }, "CreateNeedRequest": { "required": [ "cityId", "category", "title", "details", "urgency", "contactPreference", "visibility", "expiresAt" ], "type": "object", "properties": { "cityId": { "type": "string", "format": "uuid" }, "category": { "type": "string" }, "title": { "type": "string" }, "details": { "type": [ "null", "string" ] }, "urgency": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int16" }, "contactPreference": { "type": "string" }, "visibility": { "type": "string" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "CreateOfferRequest": { "required": [ "cityId", "category", "title", "details", "capacity", "visibility", "expiresAt" ], "type": "object", "properties": { "cityId": { "type": "string", "format": "uuid" }, "category": { "type": "string" }, "title": { "type": "string" }, "details": { "type": [ "null", "string" ] }, "capacity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int16" }, "visibility": { "type": "string" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "CreateOrganizationRequest": { "required": [ "cityId", "name", "slug", "organizationType", "description", "websiteUrl" ], "type": "object", "properties": { "cityId": { "type": [ "null", "string" ], "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" }, "organizationType": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "websiteUrl": { "type": [ "null", "string" ] } } }, "CreateReportRequest": { "required": [ "subjectUserId", "entityType", "entityId", "category", "description" ], "type": "object", "properties": { "subjectUserId": { "type": [ "null", "string" ], "format": "uuid" }, "entityType": { "type": "string" }, "entityId": { "type": [ "null", "string" ], "format": "uuid" }, "category": { "type": "string" }, "description": { "type": "string" } } }, "CreateResourceRequest": { "required": [ "cityId", "organizationId", "title", "summary", "category", "websiteUrl", "phone", "addressText", "representativeContactConsent" ], "type": "object", "properties": { "cityId": { "type": "string", "format": "uuid" }, "organizationId": { "type": [ "null", "string" ], "format": "uuid" }, "title": { "type": "string" }, "summary": { "type": "string" }, "category": { "type": "string" }, "websiteUrl": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "addressText": { "type": [ "null", "string" ] }, "representativeContactConsent": { "type": "boolean" } } }, "IFormFile": { "type": "string", "format": "binary" }, "ModerateReportRequest": { "required": [ "status", "actionType", "rationale" ], "type": "object", "properties": { "status": { "type": "string" }, "actionType": { "type": "string" }, "rationale": { "type": "string" } } }, "OneEeChatRequest": { "required": [ "messages" ], "type": "object", "properties": { "messages": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OneEeMessage" } } } }, "OneEeMessage": { "required": [ "role", "content" ], "type": "object", "properties": { "role": { "type": "string" }, "content": { "type": "string" } } }, "RecordConsentRequest": { "required": [ "accepted" ], "type": "object", "properties": { "accepted": { "type": "boolean" } } }, "RefreshTokenRequest": { "required": [ "refreshToken" ], "type": "object", "properties": { "refreshToken": { "type": "string" } } }, "RegisterRequest": { "required": [ "email", "password", "displayName" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "displayName": { "type": [ "null", "string" ] } } }, "ResourceCategoryRequest": { "required": [ "slug", "name", "description", "displayOrder", "isActive" ], "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isActive": { "type": "boolean" } } }, "RsvpRequest": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" } } }, "SendIntroductionMessageRequest": { "required": [ "clientMessageId", "body" ], "type": "object", "properties": { "clientMessageId": { "type": "string", "format": "uuid" }, "body": { "type": "string" } } }, "SignInRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } } }, "UpdateContactMessageStatusRequest": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" } } }, "UpdateNeedRequest": { "required": [ "title", "details", "urgency", "contactPreference", "visibility", "status" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "details": { "type": [ "null", "string" ] }, "urgency": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int16" }, "contactPreference": { "type": [ "null", "string" ] }, "visibility": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] } } }, "UpdateOfferRequest": { "required": [ "title", "details", "capacity", "visibility", "status" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "details": { "type": [ "null", "string" ] }, "capacity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int16" }, "visibility": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] } } }, "UpdateOrganizationRequest": { "required": [ "name", "description", "websiteUrl" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "websiteUrl": { "type": [ "null", "string" ] } } }, "UpdateProfileRequest": { "required": [ "cityId", "displayName", "profession", "bio", "isNewcomer", "arrivalYear", "contactPreferences", "visibility", "acceptTerms", "confirmAdult", "phone" ], "type": "object", "properties": { "cityId": { "type": [ "null", "string" ], "format": "uuid" }, "displayName": { "type": "string" }, "profession": { "type": [ "null", "string" ] }, "bio": { "type": [ "null", "string" ] }, "isNewcomer": { "type": "boolean" }, "arrivalYear": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int16" }, "contactPreferences": { "type": "array", "items": { "type": "string" } }, "visibility": { "type": "string" }, "acceptTerms": { "type": "boolean" }, "confirmAdult": { "type": "boolean" }, "phone": { "type": [ "null", "string" ] } } }, "UpdateResourceRequest": { "required": [ "title", "summary", "websiteUrl", "phone", "addressText", "status" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "websiteUrl": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "addressText": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] } } }, "UpsertIntroductionContactRequest": { "required": [ "contactType", "contactValue" ], "type": "object", "properties": { "contactType": { "type": "string" }, "contactValue": { "type": "string" } } }, "UpsertOrganizationMemberRequest": { "required": [ "userId", "memberRole", "status" ], "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "memberRole": { "type": "string" }, "status": { "type": "string" } } }, "VerifyOrganizationRequest": { "required": [ "status", "expiresAt" ], "type": "object", "properties": { "status": { "type": "string" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "VerifyResourceRequest": { "required": [ "status", "expiresAt", "isAuthoritative" ], "type": "object", "properties": { "status": { "type": "string" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "isAuthoritative": { "type": "boolean" } } } } }, "tags": [ { "name": "One-ee" }, { "name": "Donations" }, { "name": "OneYaadEndpoints" }, { "name": "AdminContentEndpoints" } ] }