2017 © Pedro Peláez
 

library api-specification

MyParcel.com API specification based on the OpenAPI Specification.

image

myparcelcom/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  • Friday, July 20, 2018
  • by myparcelcom
  • Repository
  • 5 Watchers
  • 0 Stars
  • 1,737 Installations
  • CSS
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 100 Versions
  • 76 % Grown

The README.md

MyParcel.com API specification

Packagist OpenAPI Specification, (*1)

Description of the API specification used by MyParcel.com located at https://api-specification.myparcel.com. This specification adheres to the OpenApi 3.1 specification and implements the JSON API specification., (*2)

Content

Installation

The repository provides Docker containers to validate and preview the spec before committing changes. This is also used when validating pull requests. To install Docker, follow the steps in the documentation., (*3)

To set up the project for development run:, (*4)

./mp.sh setup

Commands

./mp.sh up - Start the containers which will start a server to watch file changes and reload automatically., (*5)

./mp.sh down - Stop the containers., (*6)

./mp.sh validate - Validate the specification., (*7)

NOTE: The validator only works when the containers are already running. Don't forget to start them., (*8)

Conventions

Conventions based on the Swagger and JSON Schema specs., (*9)

Our internal conventions are described below., (*10)

PUT, POST, PATCH

To avoid discussion, the use of the above HTTP methods is described below., (*11)

PUT

  • Used to create or replace a resource.
  • Always returns the same response on repeated requests.
  • Needs the full resource for the request (including the id for the to be created or replaced resource).

POST

  • Used to create a resource.
  • Does not return the same response on repeated requests.
  • Does not need the full resource for the request (often does not need the id for the to be created resource).

PATCH

  • Used to update an existing resource.
  • Does not return the same response on repeated requests.
  • Does not need the full resource for the request (you might only want to update a user's name for example).

API versioning

The API versioning follows semantic versioning. The increment in version number is done manually and should be part of the pull request., (*12)

Schema file naming

Definition file names follow PascalCasing. Where every first letter of a word (including the first word) is uppercase. For example, the definition for a country code would be found in:, (*13)

specification/schemas/CountryCode.json

Path file naming

The files in specification/paths are named after their corresponding API endpoints. Where resources start with an uppercase letter and path variables with a lowercase letter. For example, the definition of the following route:, (*14)

carriers/{carrier_id}/services

can be found in:, (*15)

specification/paths/Carriers-carrier_id-Services.json

Parameter file naming

Parameter file names are prefixed with the corresponding parameter type. A path parameter for carrier_id would get the following file path:, (*16)

specification/parameters/path-carrier_id.json

Unique parameters can just remain in the path file and do not need to be extracted to their own files., (*17)

License

All software by MyParcel.com is licensed under the MyParcel.com general terms and conditions., (*18)

The Versions

20/07 2018

dev-master

9999999-dev https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

20/07 2018

dev-feature/maintenance

dev-feature/maintenance https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

20/07 2018

v0.20.7

0.20.7.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

19/07 2018

dev-feature/MP-1189-add-certificate-and-license-number-to-customs

dev-feature/MP-1189-add-certificate-and-license-number-to-customs https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

18/07 2018

dev-feature/MP-1193-Add-sub_region-field-to-address-resource

dev-feature/MP-1193-Add-sub_region-field-to-address-resource https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

17/07 2018

v0.20.6

0.20.6.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

17/07 2018

v0.20.5

0.20.5.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

17/07 2018

v0.20.4

0.20.4.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

16/07 2018

v0.20.3

0.20.3.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

10/07 2018

v0.20.2

0.20.2.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

10/07 2018

v0.20.1

0.20.1.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

22/06 2018

v0.20.0

0.20.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

22/06 2018

v0.19.0

0.19.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

20/06 2018

v0.18.3

0.18.3.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

19/06 2018

v0.18.2

0.18.2.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

18/06 2018

v0.18.1

0.18.1.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

14/06 2018

v0.18

0.18.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

12/06 2018

v0.17.1

0.17.1.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

11/06 2018

v0.17.0

0.17.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

11/06 2018

dev-feature/MP-440-carrier-contracts-post-del-patch

dev-feature/MP-440-carrier-contracts-post-del-patch https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

08/06 2018

v0.16.3

0.16.3.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

05/06 2018

v0.16.2

0.16.2.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

05/06 2018

v0.16.1

0.16.1.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

30/05 2018

v0.16.0

0.16.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

30/05 2018

dev-feature/MP-883-pudo-categories

dev-feature/MP-883-pudo-categories https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

28/05 2018

v0.15.1

0.15.1.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

25/05 2018

v0.15.0

0.15.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

23/05 2018

v0.14.2

0.14.2.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

23/05 2018

v0.14.1

0.14.1.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

22/05 2018

v0.14.0

0.14.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

21/05 2018

v0.13.4

0.13.4.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

16/05 2018

v0.13.3

0.13.3.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

07/05 2018

v0.13.2

0.13.2.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

07/05 2018

v0.13.1

0.13.1.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

04/05 2018

v0.13.0

0.13.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

04/05 2018

v0.12.1

0.12.1.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

03/05 2018

v0.12.0

0.12.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

02/05 2018

v0.11.0

0.11.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

02/05 2018

dev-feature/readOnly

dev-feature/readOnly https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

01/05 2018

dev-feature/add-broker-relationship-to-organization

dev-feature/add-broker-relationship-to-organization https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

01/05 2018

dev-feature/system-message-to-experimental

dev-feature/system-message-to-experimental https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

01/05 2018

dev-feature/add-billing-attributes-to-organization-spec

dev-feature/add-billing-attributes-to-organization-spec https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

30/04 2018

v0.10.17

0.10.17.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

30/04 2018

dev-feature/organization-endpoints

dev-feature/organization-endpoints https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

30/04 2018

v0.10.16

0.10.16.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

30/04 2018

dev-bugfix/add-id-to-patch-endpoints

dev-bugfix/add-id-to-patch-endpoints https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

26/04 2018

v0.10.15

0.10.15.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

26/04 2018

v0.10.14

0.10.14.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

26/04 2018

dev-feature/hooks

dev-feature/hooks https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

09/04 2018

v0.10.13

0.10.13.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

08/04 2018

v0.10.12

0.10.12.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

06/04 2018

v0.10.11

0.10.11.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

06/04 2018

v0.10.10

0.10.10.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

05/04 2018

v0.10.9

0.10.9.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

29/03 2018

v0.10.8

0.10.8.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

29/03 2018

dev-feature/delivery-method

dev-feature/delivery-method https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

22/03 2018

v0.10.7

0.10.7.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

21/03 2018

v0.10.6

0.10.6.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

20/03 2018

dev-feature/address-endpoint

dev-feature/address-endpoint https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

19/03 2018

v0.10.5

0.10.5.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

15/03 2018

v0.10.4

0.10.4.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

09/03 2018

v0.10.3

0.10.3.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

08/03 2018

v0.10.2

0.10.2.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

08/03 2018

v0.10.1

0.10.1.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

07/03 2018

v0.10.0

0.10.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

02/03 2018

dev-feature/download-multiple-files

dev-feature/download-multiple-files https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

02/03 2018

v0.9.1

0.9.1.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

01/03 2018

v0.9.0

0.9.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

22/02 2018

v0.8.0

0.8.0.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

19/02 2018

v0.7.4

0.7.4.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

16/02 2018

v0.7.3

0.7.3.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

16/02 2018

v0.7.2

0.7.2.0 https://docs.myparcel.com/api-specification

MyParcel.com API specification based on the OpenAPI Specification.

  Sources   Download

08/02 2018

v0.7.1

0.7.1.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

06/02 2018

v0.7.0

0.7.0.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

05/02 2018

v0.6.0

0.6.0.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

02/02 2018

v0.5.2

0.5.2.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

26/01 2018

v0.5.1

0.5.1.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

24/01 2018

v0.5.0

0.5.0.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

18/01 2018

v0.4.7

0.4.7.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

17/01 2018

v0.4.6

0.4.6.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

17/01 2018

v0.4.5

0.4.5.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

11/01 2018

v0.4.4

0.4.4.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

22/12 2017

v0.4.3

0.4.3.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

22/12 2017

v0.4.2

0.4.2.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

19/12 2017

v0.4.1

0.4.1.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

15/12 2017

v0.4.0

0.4.0.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

07/12 2017

v0.3.0

0.3.0.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

04/12 2017

v0.2.27

0.2.27.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

04/12 2017

v0.2.26

0.2.26.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

04/12 2017

v0.2.25

0.2.25.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

01/12 2017

v0.2.24

0.2.24.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

01/12 2017

v0.2.23

0.2.23.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

29/11 2017

v0.2.22

0.2.22.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

29/11 2017

v0.2.21

0.2.21.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

28/11 2017

v0.2.20

0.2.20.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

17/11 2017

v0.2.19

0.2.19.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

17/11 2017

v0.2.18

0.2.18.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

15/11 2017

v0.2.17

0.2.17.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

08/11 2017

v0.2.16

0.2.16.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download

07/11 2017

v0.2.15

0.2.15.0 https://www.myparcel.com

MyParcel.com API specification powering the Swagger documentation.

  Sources   Download