Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • all release assets are available
  • there were not too many changes wrt the previous version
  • it is expected to not have any changes in the next 2 meta-releases
  • the TSC approves it 

M3:

...

How to put the API version in the URL ?

The servers object should look like this (API Guidelines section 11.1):

servers:

  - url: {apiRoot}/yourapiname/v0.yrc1 or v1rc1

    variables:

      apiRoot:

        default: http://localhost:9091

        description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`

M3: How to put the reference to commonalities in the info object ?

In your API yaml file, in the info object, please make sure to add: x-camara-commonalities: 0.4.0

...

    [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token.

...

  x-camara-commonalities: 0.4.0

  termsOfService: http://example.com/terms/

  contact:

    name: API Support

    url: http://www.example.com/support

    email: support@example.com

  license:

    name: Apache 2.0

    url: https://www.apache.org/licenses/LICENSE-2.0.html`