openapi: 3.2.0 info: title: Hyperlabs.Web Application Notes API version: '1.0' servers: - url: /api tags: - name: ApplicationNotes paths: /v1/application-notes: get: tags: - ApplicationNotes responses: '200': description: OK /v1/application-notes/{id}: get: tags: - ApplicationNotes parameters: - name: id in: path required: true schema: title: Guid type: string format: uuid responses: '200': description: OK /v1/application-notes/{name}: get: tags: - ApplicationNotes parameters: - name: name in: path required: true schema: title: String type: string responses: '200': description: OK /v1/admin/application-notes: get: tags: - ApplicationNotes responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] post: tags: - ApplicationNotes requestBody: content: application/json: schema: $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.ApplicationNotes.ChangeApplicationNoteDto' text/json: schema: $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.ApplicationNotes.ChangeApplicationNoteDto' application/*+json: schema: $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.ApplicationNotes.ChangeApplicationNoteDto' responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] /v1/admin/application-notes/{id}: put: tags: - ApplicationNotes parameters: - name: id in: path required: true schema: title: Guid type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.ApplicationNotes.ChangeApplicationNoteDto' text/json: schema: $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.ApplicationNotes.ChangeApplicationNoteDto' application/*+json: schema: $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.ApplicationNotes.ChangeApplicationNoteDto' responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] delete: tags: - ApplicationNotes parameters: - name: id in: path required: true schema: title: Guid type: string format: uuid responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] /v1/admin/application-notes/{id}/move: post: tags: - ApplicationNotes parameters: - name: id in: path required: true schema: title: Guid type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Shared.MoveDto' text/json: schema: $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Shared.MoveDto' application/*+json: schema: $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Shared.MoveDto' responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden security: - oauth2: [] components: schemas: Hyperlabs.Web.Areas.Admin.Models.ApplicationNotes.ChangeApplicationNoteDto: title: ChangeApplicationNoteDto type: object properties: name: title: String type: - string - 'null' title: title: String type: - string - 'null' subtitle: title: String type: - string - 'null' description: title: String type: - string - 'null' isFeatured: title: Boolean type: boolean publishingStatusCode: $ref: '#/components/schemas/Hyperlabs.Domain.Products.Models.PublishingStatusCode' images: title: Guid[] type: - array - 'null' items: title: Guid type: string format: uuid documents: title: Guid[] type: - array - 'null' items: title: Guid type: string format: uuid products: title: ChangeLinkedProductDto[] type: - array - 'null' items: $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Shared.ChangeLinkedProductDto' additionalProperties: false Hyperlabs.Web.Areas.Admin.Models.Shared.MoveDto: title: MoveDto type: object properties: delta: title: Int32 type: integer format: int32 additionalProperties: false Hyperlabs.Web.Areas.Admin.Models.Shared.ChangeLinkedProductDto: title: ChangeLinkedProductDto type: object properties: productId: title: Guid type: string format: uuid additionalProperties: false Hyperlabs.Domain.Products.Models.PublishingStatusCode: title: PublishingStatusCode enum: - 1 - 2 - 3 type: integer format: int32 securitySchemes: oauth2: type: apiKey description: 'Standard Authorization header using the Bearer scheme. Example: "Bearer {token}"' name: Authorization in: header