openapi: 3.1.0 info: title: 'Imaq Platform' description: '' version: 1.0.0 servers: - url: / description: '' paths: /api/locations: get: operationId: api_locations_get_collection tags: - Location responses: '200': description: 'Location collection' content: application/ld+json: schema: type: object properties: member: { type: array, items: { $ref: '#/components/schemas/Location.jsonld' } } totalItems: { type: integer, minimum: 0 } view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } } search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } } required: - member summary: 'Retrieves the collection of Location resources.' description: 'Retrieves the collection of Location resources.' parameters: - name: page in: query description: 'The collection page number' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: 'The number of items per page' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 50 minimum: 0 maximum: 100 style: form explode: false allowReserved: false - name: name in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false - name: custom_json_filter in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false - name: custom_json_order in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false deprecated: false post: operationId: api_locations_post tags: - Location responses: '201': description: 'Location resource created' content: application/ld+json: schema: $ref: '#/components/schemas/Location.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' summary: 'Creates a Location resource.' description: 'Creates a Location resource.' parameters: [] requestBody: description: 'The new Location resource' content: application/ld+json: schema: $ref: '#/components/schemas/Location.jsonld' required: true deprecated: false '/api/locations/{id}': get: operationId: api_locations_id_get tags: - Location responses: '200': description: 'Location resource' content: application/ld+json: schema: $ref: '#/components/schemas/Location.jsonld' '404': description: 'Resource not found' summary: 'Retrieves a Location resource.' description: 'Retrieves a Location resource.' parameters: - name: id in: path description: 'Location identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false patch: operationId: api_locations_id_patch tags: - Location responses: '200': description: 'Location resource updated' content: application/ld+json: schema: $ref: '#/components/schemas/Location.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' '404': description: 'Resource not found' summary: 'Updates the Location resource.' description: 'Updates the Location resource.' parameters: - name: id in: path description: 'Location identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false requestBody: description: 'The updated Location resource' content: application/merge-patch+json: schema: $ref: '#/components/schemas/Location' required: true deprecated: false /api/auth: post: operationId: login_check_post tags: - 'Login Check' responses: '200': description: 'User token created' content: application/json: schema: type: object properties: token: { readOnly: true, type: string, nullable: false } required: - token summary: 'Creates a user token.' description: 'Creates a user token.' requestBody: description: 'The login data' content: application/json: schema: type: object properties: email: type: string nullable: false password: type: string nullable: false required: - email - password required: true /api/media_objects: get: operationId: api_media_objects_get_collection tags: - MediaObject responses: '200': description: 'MediaObject collection' content: application/ld+json: schema: type: object properties: member: { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonld-media_object.read' } } totalItems: { type: integer, minimum: 0 } view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } } search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } } required: - member summary: 'Retrieves the collection of MediaObject resources.' description: 'Retrieves the collection of MediaObject resources.' parameters: - name: page in: query description: 'The collection page number' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: 'The number of items per page' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 50 minimum: 0 maximum: 100 style: form explode: false allowReserved: false deprecated: false post: operationId: api_media_objects_post tags: - MediaObject responses: '201': description: 'MediaObject resource created' content: application/ld+json: schema: $ref: '#/components/schemas/MediaObject.jsonld-media_object.read' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' summary: 'Creates a MediaObject resource.' description: 'Creates a MediaObject resource.' parameters: [] requestBody: description: 'The new MediaObject resource' content: multipart/form-data: schema: type: object properties: file: type: string format: binary required: false deprecated: false '/api/media_objects/{id}': get: operationId: api_media_objects_id_get tags: - MediaObject responses: '200': description: 'MediaObject resource' content: application/ld+json: schema: $ref: '#/components/schemas/MediaObject.jsonld-media_object.read' '404': description: 'Resource not found' summary: 'Retrieves a MediaObject resource.' description: 'Retrieves a MediaObject resource.' parameters: - name: id in: path description: 'MediaObject identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false delete: operationId: api_media_objects_id_delete tags: - MediaObject responses: '204': description: 'MediaObject resource deleted' '404': description: 'Resource not found' summary: 'Removes the MediaObject resource.' description: 'Removes the MediaObject resource.' parameters: - name: id in: path description: 'MediaObject identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false /api/shipping_companies: get: operationId: api_shipping_companies_get_collection tags: - ShippingCompany responses: '200': description: 'ShippingCompany collection' content: application/ld+json: schema: type: object properties: member: { type: array, items: { $ref: '#/components/schemas/ShippingCompany.jsonld' } } totalItems: { type: integer, minimum: 0 } view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } } search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } } required: - member summary: 'Retrieves the collection of ShippingCompany resources.' description: 'Retrieves the collection of ShippingCompany resources.' parameters: - name: page in: query description: 'The collection page number' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: 'The number of items per page' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 50 minimum: 0 maximum: 100 style: form explode: false allowReserved: false - name: name in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false - name: custom_json_filter in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false - name: custom_json_order in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false deprecated: false post: operationId: api_shipping_companies_post tags: - ShippingCompany responses: '201': description: 'ShippingCompany resource created' content: application/ld+json: schema: $ref: '#/components/schemas/ShippingCompany.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' summary: 'Creates a ShippingCompany resource.' description: 'Creates a ShippingCompany resource.' parameters: [] requestBody: description: 'The new ShippingCompany resource' content: application/ld+json: schema: $ref: '#/components/schemas/ShippingCompany.jsonld' required: true deprecated: false '/api/shipping_companies/{id}': get: operationId: api_shipping_companies_id_get tags: - ShippingCompany responses: '200': description: 'ShippingCompany resource' content: application/ld+json: schema: $ref: '#/components/schemas/ShippingCompany.jsonld' '404': description: 'Resource not found' summary: 'Retrieves a ShippingCompany resource.' description: 'Retrieves a ShippingCompany resource.' parameters: - name: id in: path description: 'ShippingCompany identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false patch: operationId: api_shipping_companies_id_patch tags: - ShippingCompany responses: '200': description: 'ShippingCompany resource updated' content: application/ld+json: schema: $ref: '#/components/schemas/ShippingCompany.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' '404': description: 'Resource not found' summary: 'Updates the ShippingCompany resource.' description: 'Updates the ShippingCompany resource.' parameters: - name: id in: path description: 'ShippingCompany identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false requestBody: description: 'The updated ShippingCompany resource' content: application/merge-patch+json: schema: $ref: '#/components/schemas/ShippingCompany' required: true deprecated: false /api/trips: get: operationId: api_trips_get_collection tags: - Trip responses: '200': description: 'Trip collection' content: application/ld+json: schema: type: object properties: member: { type: array, items: { $ref: '#/components/schemas/Trip.jsonld' } } totalItems: { type: integer, minimum: 0 } view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } } search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } } required: - member summary: 'Retrieves the collection of Trip resources.' description: 'Retrieves the collection of Trip resources.' parameters: - name: page in: query description: 'The collection page number' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: 'The number of items per page' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 50 minimum: 0 maximum: 100 style: form explode: false allowReserved: false deprecated: false post: operationId: api_trips_post tags: - Trip responses: '201': description: 'Trip resource created' content: application/ld+json: schema: $ref: '#/components/schemas/Trip.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' summary: 'Creates a Trip resource.' description: 'Creates a Trip resource.' parameters: [] requestBody: description: 'The new Trip resource' content: application/ld+json: schema: $ref: '#/components/schemas/Trip.jsonld' required: true deprecated: false '/api/trips/{id}': get: operationId: api_trips_id_get tags: - Trip responses: '200': description: 'Trip resource' content: application/ld+json: schema: $ref: '#/components/schemas/Trip.jsonld' '404': description: 'Resource not found' summary: 'Retrieves a Trip resource.' description: 'Retrieves a Trip resource.' parameters: - name: id in: path description: 'Trip identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false patch: operationId: api_trips_id_patch tags: - Trip responses: '200': description: 'Trip resource updated' content: application/ld+json: schema: $ref: '#/components/schemas/Trip.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' '404': description: 'Resource not found' summary: 'Updates the Trip resource.' description: 'Updates the Trip resource.' parameters: - name: id in: path description: 'Trip identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false requestBody: description: 'The updated Trip resource' content: application/merge-patch+json: schema: $ref: '#/components/schemas/Trip' required: true deprecated: false /api/trip_locations: get: operationId: api_trip_locations_get_collection tags: - TripLocation responses: '200': description: 'TripLocation collection' content: application/ld+json: schema: type: object properties: member: { type: array, items: { $ref: '#/components/schemas/TripLocation.jsonld' } } totalItems: { type: integer, minimum: 0 } view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } } search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } } required: - member summary: 'Retrieves the collection of TripLocation resources.' description: 'Retrieves the collection of TripLocation resources.' parameters: - name: page in: query description: 'The collection page number' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: 'The number of items per page' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 50 minimum: 0 maximum: 100 style: form explode: false allowReserved: false deprecated: false post: operationId: api_trip_locations_post tags: - TripLocation responses: '201': description: 'TripLocation resource created' content: application/ld+json: schema: $ref: '#/components/schemas/TripLocation.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' summary: 'Creates a TripLocation resource.' description: 'Creates a TripLocation resource.' parameters: [] requestBody: description: 'The new TripLocation resource' content: application/ld+json: schema: $ref: '#/components/schemas/TripLocation.jsonld' required: true deprecated: false '/api/trip_locations/{id}': get: operationId: api_trip_locations_id_get tags: - TripLocation responses: '200': description: 'TripLocation resource' content: application/ld+json: schema: $ref: '#/components/schemas/TripLocation.jsonld' '404': description: 'Resource not found' summary: 'Retrieves a TripLocation resource.' description: 'Retrieves a TripLocation resource.' parameters: - name: id in: path description: 'TripLocation identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false patch: operationId: api_trip_locations_id_patch tags: - TripLocation responses: '200': description: 'TripLocation resource updated' content: application/ld+json: schema: $ref: '#/components/schemas/TripLocation.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' '404': description: 'Resource not found' summary: 'Updates the TripLocation resource.' description: 'Updates the TripLocation resource.' parameters: - name: id in: path description: 'TripLocation identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false requestBody: description: 'The updated TripLocation resource' content: application/merge-patch+json: schema: $ref: '#/components/schemas/TripLocation' required: true deprecated: false /api/users: get: operationId: api_users_get_collection tags: - User responses: '200': description: 'User collection' content: application/ld+json: schema: type: object properties: member: { type: array, items: { $ref: '#/components/schemas/User.jsonld' } } totalItems: { type: integer, minimum: 0 } view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } } search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } } required: - member summary: 'Retrieves the collection of User resources.' description: 'Retrieves the collection of User resources.' parameters: - name: page in: query description: 'The collection page number' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: 'The number of items per page' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 50 minimum: 0 maximum: 100 style: form explode: false allowReserved: false - name: firstName in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false - name: lastName in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false - name: userNameSearch in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false - name: custom_json_order in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false deprecated: false post: operationId: api_users_post tags: - User responses: '201': description: 'User resource created' content: application/ld+json: schema: $ref: '#/components/schemas/User.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' summary: 'Creates a User resource.' description: 'Creates a User resource.' parameters: [] requestBody: description: 'The new User resource' content: application/ld+json: schema: $ref: '#/components/schemas/User.jsonld' required: true deprecated: false '/api/users/{id}': get: operationId: api_users_id_get tags: - User responses: '200': description: 'User resource' content: application/ld+json: schema: $ref: '#/components/schemas/User.jsonld' '404': description: 'Resource not found' summary: 'Retrieves a User resource.' description: 'Retrieves a User resource.' parameters: - name: id in: path description: 'User identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false patch: operationId: api_users_id_patch tags: - User responses: '200': description: 'User resource updated' content: application/ld+json: schema: $ref: '#/components/schemas/User.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' '404': description: 'Resource not found' summary: 'Updates the User resource.' description: 'Updates the User resource.' parameters: - name: id in: path description: 'User identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false requestBody: description: 'The updated User resource' content: application/merge-patch+json: schema: $ref: '#/components/schemas/User' required: true deprecated: false /api/user_trips: get: operationId: api_user_trips_get_collection tags: - UserTrip responses: '200': description: 'UserTrip collection' content: application/ld+json: schema: type: object properties: member: { type: array, items: { $ref: '#/components/schemas/UserTrip.jsonld' } } totalItems: { type: integer, minimum: 0 } view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } } search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } } required: - member summary: 'Retrieves the collection of UserTrip resources.' description: 'Retrieves the collection of UserTrip resources.' parameters: - name: page in: query description: 'The collection page number' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: 'The number of items per page' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 50 minimum: 0 maximum: 100 style: form explode: false allowReserved: false deprecated: false post: operationId: api_user_trips_post tags: - UserTrip responses: '201': description: 'UserTrip resource created' content: application/ld+json: schema: $ref: '#/components/schemas/UserTrip.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' summary: 'Creates a UserTrip resource.' description: 'Creates a UserTrip resource.' parameters: [] requestBody: description: 'The new UserTrip resource' content: application/ld+json: schema: $ref: '#/components/schemas/UserTrip.jsonld' required: true deprecated: false '/api/user_trips/{id}': get: operationId: api_user_trips_id_get tags: - UserTrip responses: '200': description: 'UserTrip resource' content: application/ld+json: schema: $ref: '#/components/schemas/UserTrip.jsonld' '404': description: 'Resource not found' summary: 'Retrieves a UserTrip resource.' description: 'Retrieves a UserTrip resource.' parameters: - name: id in: path description: 'UserTrip identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false patch: operationId: api_user_trips_id_patch tags: - UserTrip responses: '200': description: 'UserTrip resource updated' content: application/ld+json: schema: $ref: '#/components/schemas/UserTrip.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' '404': description: 'Resource not found' summary: 'Updates the UserTrip resource.' description: 'Updates the UserTrip resource.' parameters: - name: id in: path description: 'UserTrip identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false requestBody: description: 'The updated UserTrip resource' content: application/merge-patch+json: schema: $ref: '#/components/schemas/UserTrip' required: true deprecated: false /api/user_trip_locations: get: operationId: api_user_trip_locations_get_collection tags: - UserTripLocation responses: '200': description: 'UserTripLocation collection' content: application/ld+json: schema: type: object properties: member: { type: array, items: { $ref: '#/components/schemas/UserTripLocation.jsonld' } } totalItems: { type: integer, minimum: 0 } view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } } search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } } required: - member summary: 'Retrieves the collection of UserTripLocation resources.' description: 'Retrieves the collection of UserTripLocation resources.' parameters: - name: page in: query description: 'The collection page number' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: 'The number of items per page' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 50 minimum: 0 maximum: 100 style: form explode: false allowReserved: false deprecated: false post: operationId: api_user_trip_locations_post tags: - UserTripLocation responses: '201': description: 'UserTripLocation resource created' content: application/ld+json: schema: $ref: '#/components/schemas/UserTripLocation.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' summary: 'Creates a UserTripLocation resource.' description: 'Creates a UserTripLocation resource.' parameters: [] requestBody: description: 'The new UserTripLocation resource' content: application/ld+json: schema: $ref: '#/components/schemas/UserTripLocation.jsonld' required: true deprecated: false '/api/user_trip_locations/{id}': get: operationId: api_user_trip_locations_id_get tags: - UserTripLocation responses: '200': description: 'UserTripLocation resource' content: application/ld+json: schema: $ref: '#/components/schemas/UserTripLocation.jsonld' '404': description: 'Resource not found' summary: 'Retrieves a UserTripLocation resource.' description: 'Retrieves a UserTripLocation resource.' parameters: - name: id in: path description: 'UserTripLocation identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false patch: operationId: api_user_trip_locations_id_patch tags: - UserTripLocation responses: '200': description: 'UserTripLocation resource updated' content: application/ld+json: schema: $ref: '#/components/schemas/UserTripLocation.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' '404': description: 'Resource not found' summary: 'Updates the UserTripLocation resource.' description: 'Updates the UserTripLocation resource.' parameters: - name: id in: path description: 'UserTripLocation identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false requestBody: description: 'The updated UserTripLocation resource' content: application/merge-patch+json: schema: $ref: '#/components/schemas/UserTripLocation' required: true deprecated: false /api/user_trip_work_logs: get: operationId: api_user_trip_work_logs_get_collection tags: - UserTripWorkLog responses: '200': description: 'UserTripWorkLog collection' content: application/ld+json: schema: type: object properties: member: { type: array, items: { $ref: '#/components/schemas/UserTripWorkLog.jsonld' } } totalItems: { type: integer, minimum: 0 } view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } } search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } } required: - member summary: 'Retrieves the collection of UserTripWorkLog resources.' description: 'Retrieves the collection of UserTripWorkLog resources.' parameters: - name: page in: query description: 'The collection page number' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: 'The number of items per page' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 50 minimum: 0 maximum: 100 style: form explode: false allowReserved: false deprecated: false post: operationId: api_user_trip_work_logs_post tags: - UserTripWorkLog responses: '201': description: 'UserTripWorkLog resource created' content: application/ld+json: schema: $ref: '#/components/schemas/UserTripWorkLog.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' summary: 'Creates a UserTripWorkLog resource.' description: 'Creates a UserTripWorkLog resource.' parameters: [] requestBody: description: 'The new UserTripWorkLog resource' content: application/ld+json: schema: $ref: '#/components/schemas/UserTripWorkLog.jsonld' required: true deprecated: false '/api/user_trip_work_logs/{id}': get: operationId: api_user_trip_work_logs_id_get tags: - UserTripWorkLog responses: '200': description: 'UserTripWorkLog resource' content: application/ld+json: schema: $ref: '#/components/schemas/UserTripWorkLog.jsonld' '404': description: 'Resource not found' summary: 'Retrieves a UserTripWorkLog resource.' description: 'Retrieves a UserTripWorkLog resource.' parameters: - name: id in: path description: 'UserTripWorkLog identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false patch: operationId: api_user_trip_work_logs_id_patch tags: - UserTripWorkLog responses: '200': description: 'UserTripWorkLog resource updated' content: application/ld+json: schema: $ref: '#/components/schemas/UserTripWorkLog.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' '404': description: 'Resource not found' summary: 'Updates the UserTripWorkLog resource.' description: 'Updates the UserTripWorkLog resource.' parameters: - name: id in: path description: 'UserTripWorkLog identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false requestBody: description: 'The updated UserTripWorkLog resource' content: application/merge-patch+json: schema: $ref: '#/components/schemas/UserTripWorkLog' required: true deprecated: false /api/vessels: get: operationId: api_vessels_get_collection tags: - Vessel responses: '200': description: 'Vessel collection' content: application/ld+json: schema: type: object properties: member: { type: array, items: { $ref: '#/components/schemas/Vessel.jsonld' } } totalItems: { type: integer, minimum: 0 } view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } } search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } } required: - member summary: 'Retrieves the collection of Vessel resources.' description: 'Retrieves the collection of Vessel resources.' parameters: - name: page in: query description: 'The collection page number' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: 'The number of items per page' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 50 minimum: 0 maximum: 100 style: form explode: false allowReserved: false - name: name in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false - name: custom_json_filter in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false - name: custom_json_order in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false deprecated: false post: operationId: api_vessels_post tags: - Vessel responses: '201': description: 'Vessel resource created' content: application/ld+json: schema: $ref: '#/components/schemas/Vessel.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' summary: 'Creates a Vessel resource.' description: 'Creates a Vessel resource.' parameters: [] requestBody: description: 'The new Vessel resource' content: application/ld+json: schema: $ref: '#/components/schemas/Vessel.jsonld' required: true deprecated: false '/api/vessels/{id}': get: operationId: api_vessels_id_get tags: - Vessel responses: '200': description: 'Vessel resource' content: application/ld+json: schema: $ref: '#/components/schemas/Vessel.jsonld' '404': description: 'Resource not found' summary: 'Retrieves a Vessel resource.' description: 'Retrieves a Vessel resource.' parameters: - name: id in: path description: 'Vessel identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false patch: operationId: api_vessels_id_patch tags: - Vessel responses: '200': description: 'Vessel resource updated' content: application/ld+json: schema: $ref: '#/components/schemas/Vessel.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' '404': description: 'Resource not found' summary: 'Updates the Vessel resource.' description: 'Updates the Vessel resource.' parameters: - name: id in: path description: 'Vessel identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false requestBody: description: 'The updated Vessel resource' content: application/merge-patch+json: schema: $ref: '#/components/schemas/Vessel' required: true deprecated: false /api/zones: get: operationId: api_zones_get_collection tags: - Zone responses: '200': description: 'Zone collection' content: application/ld+json: schema: type: object properties: member: { type: array, items: { $ref: '#/components/schemas/Zone.jsonld' } } totalItems: { type: integer, minimum: 0 } view: { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, first: { type: string, format: iri-reference }, last: { type: string, format: iri-reference }, previous: { type: string, format: iri-reference }, next: { type: string, format: iri-reference } }, example: { '@id': string, type: string, first: string, last: string, previous: string, next: string } } search: { type: object, properties: { '@type': { type: string }, template: { type: string }, variableRepresentation: { type: string }, mapping: { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } } required: - member summary: 'Retrieves the collection of Zone resources.' description: 'Retrieves the collection of Zone resources.' parameters: - name: page in: query description: 'The collection page number' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - name: itemsPerPage in: query description: 'The number of items per page' required: false deprecated: false allowEmptyValue: true schema: type: integer default: 50 minimum: 0 maximum: 100 style: form explode: false allowReserved: false - name: name in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false - name: custom_json_filter in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false - name: custom_json_order in: query description: '' required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false deprecated: false post: operationId: api_zones_post tags: - Zone responses: '201': description: 'Zone resource created' content: application/ld+json: schema: $ref: '#/components/schemas/Zone.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' summary: 'Creates a Zone resource.' description: 'Creates a Zone resource.' parameters: [] requestBody: description: 'The new Zone resource' content: application/ld+json: schema: $ref: '#/components/schemas/Zone.jsonld' required: true deprecated: false '/api/zones/{id}': get: operationId: api_zones_id_get tags: - Zone responses: '200': description: 'Zone resource' content: application/ld+json: schema: $ref: '#/components/schemas/Zone.jsonld' '404': description: 'Resource not found' summary: 'Retrieves a Zone resource.' description: 'Retrieves a Zone resource.' parameters: - name: id in: path description: 'Zone identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false deprecated: false patch: operationId: api_zones_id_patch tags: - Zone responses: '200': description: 'Zone resource updated' content: application/ld+json: schema: $ref: '#/components/schemas/Zone.jsonld' links: { } '400': description: 'Invalid input' '422': description: 'Unprocessable entity' '404': description: 'Resource not found' summary: 'Updates the Zone resource.' description: 'Updates the Zone resource.' parameters: - name: id in: path description: 'Zone identifier' required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false requestBody: description: 'The updated Zone resource' content: application/merge-patch+json: schema: $ref: '#/components/schemas/Zone' required: true deprecated: false components: schemas: Location: type: object description: '' deprecated: false properties: zone: readOnly: true type: string format: iri-reference example: 'https://example.com/' name: type: string zoneName: readOnly: true type: string createdAt: readOnly: true type: - string - 'null' format: date-time required: - name Location.jsonld: type: object description: '' deprecated: false properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: ['http://www.w3.org/ns/hydra/core#'] required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string zone: readOnly: true $ref: '#/components/schemas/Zone.jsonld' name: type: string zoneName: readOnly: true type: string createdAt: readOnly: true type: - string - 'null' format: date-time required: - name MediaObject.jsonld-media_object.read: type: object description: '' deprecated: false externalDocs: url: 'https://schema.org/MediaObject' properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: ['http://www.w3.org/ns/hydra/core#'] required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string contentUrl: externalDocs: url: 'https://schema.org/contentUrl' type: - string - 'null' ShippingCompany: type: object description: '' deprecated: false required: - name properties: name: type: string createdAt: readOnly: true type: - string - 'null' format: date-time ShippingCompany.jsonld: type: object description: '' deprecated: false required: - name properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: ['http://www.w3.org/ns/hydra/core#'] required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string name: type: string createdAt: readOnly: true type: - string - 'null' format: date-time Trip: type: object description: '' deprecated: false properties: vessel: readOnly: true type: string format: iri-reference example: 'https://example.com/' pilotReference: type: string captainName: type: - string - 'null' startLocation: readOnly: true type: string format: iri-reference example: 'https://example.com/' endLocation: readOnly: true type: string format: iri-reference example: 'https://example.com/' startDate: type: - string - 'null' format: date-time endDate: type: - string - 'null' format: date-time createdAt: readOnly: true type: - string - 'null' format: date-time required: - pilotReference - startDate - endDate Trip.jsonld: type: object description: '' deprecated: false properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: ['http://www.w3.org/ns/hydra/core#'] required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string vessel: readOnly: true $ref: '#/components/schemas/Vessel.jsonld' pilotReference: type: string captainName: type: - string - 'null' startLocation: readOnly: true $ref: '#/components/schemas/Location.jsonld' endLocation: readOnly: true $ref: '#/components/schemas/Location.jsonld' startDate: type: - string - 'null' format: date-time endDate: type: - string - 'null' format: date-time createdAt: readOnly: true type: - string - 'null' format: date-time required: - pilotReference - startDate - endDate TripLocation: type: object description: '' deprecated: false properties: trip: readOnly: true type: string format: iri-reference example: 'https://example.com/' location: readOnly: true type: string format: iri-reference example: 'https://example.com/' date: type: - string - 'null' format: date-time createdAt: readOnly: true type: - string - 'null' format: date-time required: - date TripLocation.jsonld: type: object description: '' deprecated: false properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: ['http://www.w3.org/ns/hydra/core#'] required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string trip: readOnly: true $ref: '#/components/schemas/Trip.jsonld' location: readOnly: true $ref: '#/components/schemas/Location.jsonld' date: type: - string - 'null' format: date-time createdAt: readOnly: true type: - string - 'null' format: date-time required: - date User: type: object description: '' deprecated: false required: - email - firstName - lastName properties: email: format: email externalDocs: url: 'https://schema.org/email' type: - string - 'null' firstName: type: - string - 'null' lastName: type: - string - 'null' image: type: - string - 'null' format: iri-reference example: 'https://example.com/' imageUrl: readOnly: true type: - string - 'null' fullName: readOnly: true type: - string - 'null' password: writeOnly: true description: 'The plaintext password when being set or changed.' type: - string - 'null' active: type: boolean createdAt: readOnly: true type: - string - 'null' format: date-time User.jsonld: type: object description: '' deprecated: false required: - email - firstName - lastName properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: ['http://www.w3.org/ns/hydra/core#'] required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string email: format: email externalDocs: url: 'https://schema.org/email' type: - string - 'null' firstName: type: - string - 'null' lastName: type: - string - 'null' image: type: - string - 'null' format: iri-reference example: 'https://example.com/' imageUrl: readOnly: true type: - string - 'null' fullName: readOnly: true type: - string - 'null' password: writeOnly: true description: 'The plaintext password when being set or changed.' type: - string - 'null' active: type: boolean createdAt: readOnly: true type: - string - 'null' format: date-time UserTrip: type: object description: '' deprecated: false properties: trip: readOnly: true type: string format: iri-reference example: 'https://example.com/' user: readOnly: true type: string format: iri-reference example: 'https://example.com/' captainName: type: string startDate: type: - string - 'null' format: date-time endDate: type: - string - 'null' format: date-time createdAt: readOnly: true type: - string - 'null' format: date-time required: - captainName - startDate - endDate UserTrip.jsonld: type: object description: '' deprecated: false properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: ['http://www.w3.org/ns/hydra/core#'] required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string trip: readOnly: true $ref: '#/components/schemas/Trip.jsonld' user: readOnly: true $ref: '#/components/schemas/User.jsonld' captainName: type: string startDate: type: - string - 'null' format: date-time endDate: type: - string - 'null' format: date-time createdAt: readOnly: true type: - string - 'null' format: date-time required: - captainName - startDate - endDate UserTripLocation: type: object description: '' deprecated: false properties: userTrip: readOnly: true type: string format: iri-reference example: 'https://example.com/' location: readOnly: true type: string format: iri-reference example: 'https://example.com/' plannedDate: type: - string - 'null' format: date-time createdAt: readOnly: true type: - string - 'null' format: date-time required: - plannedDate UserTripLocation.jsonld: type: object description: '' deprecated: false properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: ['http://www.w3.org/ns/hydra/core#'] required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string userTrip: readOnly: true $ref: '#/components/schemas/UserTrip.jsonld' location: readOnly: true $ref: '#/components/schemas/Location.jsonld' plannedDate: type: - string - 'null' format: date-time createdAt: readOnly: true type: - string - 'null' format: date-time required: - plannedDate UserTripWorkLog: type: object description: '' deprecated: false properties: userTrip: readOnly: true type: string format: iri-reference example: 'https://example.com/' startLocation: readOnly: true type: string format: iri-reference example: 'https://example.com/' endLocation: readOnly: true type: string format: iri-reference example: 'https://example.com/' startDate: type: - string - 'null' format: date-time endDate: type: - string - 'null' format: date-time createdAt: readOnly: true type: - string - 'null' format: date-time required: - startDate - endDate UserTripWorkLog.jsonld: type: object description: '' deprecated: false properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: ['http://www.w3.org/ns/hydra/core#'] required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string userTrip: readOnly: true $ref: '#/components/schemas/UserTrip.jsonld' startLocation: readOnly: true $ref: '#/components/schemas/Location.jsonld' endLocation: readOnly: true $ref: '#/components/schemas/Location.jsonld' startDate: type: - string - 'null' format: date-time endDate: type: - string - 'null' format: date-time createdAt: readOnly: true type: - string - 'null' format: date-time required: - startDate - endDate Vessel: type: object description: '' deprecated: false required: - name properties: name: type: string company: readOnly: true type: string format: iri-reference example: 'https://example.com/' createdAt: readOnly: true type: - string - 'null' format: date-time Vessel.jsonld: type: object description: '' deprecated: false required: - name properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: ['http://www.w3.org/ns/hydra/core#'] required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string name: type: string company: readOnly: true $ref: '#/components/schemas/ShippingCompany.jsonld' createdAt: readOnly: true type: - string - 'null' format: date-time Zone: type: object description: '' deprecated: false required: - name properties: name: type: string createdAt: readOnly: true type: - string - 'null' format: date-time Zone.jsonld: type: object description: '' deprecated: false required: - name properties: '@context': readOnly: true oneOf: - type: string - type: object properties: '@vocab': type: string hydra: type: string enum: ['http://www.w3.org/ns/hydra/core#'] required: - '@vocab' - hydra additionalProperties: true '@id': readOnly: true type: string '@type': readOnly: true type: string name: type: string createdAt: readOnly: true type: - string - 'null' format: date-time responses: { } parameters: { } examples: { } requestBodies: { } headers: { } securitySchemes: JWT: type: http scheme: bearer bearerFormat: JWT security: - JWT: [] tags: [] webhooks: { }