Changelog Organisations

Remove the v1 and v2 apis and related code

Fix open api spec for getAliasForOrganisationById endpoint

The v2 beta endpoints have now been disabled in all environments

The v1 endpoints have now been disabled in the Prod environment

The v1 endpoints have now been disabled in the Staging environment

The v1 endpoints have now been disabled in the Dev environment

• Changes for organisations v3:
  • The v3 api is now officially no longer in Beta

• Changes for organisations v3:
  • The internalId field is now optional in all response types to help consumers migrate to use the organisationId field instead

• Changes for organisations v3:
  • masterId field has been removed from the api

• Changes for organisations v3:
  • The enturAgreement field has been removed

• Kafka schema changes for organisations v3:
  • The internalId field has been removed - use organisationId instead
  • The masterId field has been removed - use organisationId instead
  • The enturAgreement has been removed - field was not in use
  • The organisationId field has been added

• Changes for organisations v3:
  • The /{id} endpoint now accepts organisationId
  • The /internal/{id} has been deprecated
  • The masterId field has been deprecated for all entities
  • The enturAgreement field has been deprecated for all entities

• Changes for organisations v3:
  • The internalId field has been deprecated in the response from the v3 endpoints - use organisationId instead

• The following field does not longer return any data in the v1 api:
  • zoneBasedConfig

• The following keys have been removed from the references field in the v1 api:
  • networkId
  • registrarId

• The following keys have been removed from the references field in the v1 api:
  • networkId
  • registrarId

• Fixed endpoints and server urls in v3 swagger documentation
• Additional base path added. New base path is https://api.{{environment}}.entur.io/organisations/v3

• The following keys have been removed from the references field in the v1 api:
  • netexId
  • useEnturMt
• senderEmail has been removed from the v1 extentions endpoint

API Requests to V1 without either an Et-Client-Name header or a clientId will now be blocked. Please supply the header Et-Client-Name with your requests to identify yourself according to the Authentication Guide

API Requests to V1 without either an Et-Client-Name header or a clientId will now be blocked. Please supply the header Et-Client-Name with your requests to identify yourself according to the Authentication Guide

The v1 and v2 beta of the API is now Deprecated. The end of life date is set to January 31, 2025. Consumers should start to look at the v3 Beta API

• Deprecate the logo field from Organisations v1 as this field is not in use and will be removed in v2 of the api

• From this moment forth, Organisations V1 will now be served from a new application
• Removed certain V1 endpoints:
  • PUT /organisations
  • PUT /organisations/update-netex-authority-ids-whitelists
  • GET /organisations/export
  • PUT /organisations/{organisation_id}/{name}
• For the removed V1 endpoints, use V2-beta endpoints instead
• V2-beta is currently work in progress - please contact Team Avtale if you have any questions or feedback

• Add swagger schema required on Id in OrganisationDTO and OrganisationExportDTO

• Added new endpoint to create/update Netex Authority Whitelists
  • PUT {{organisations}}/organisations/update-netex-authority-ids-whitelists

• Add ZoneBasedConfig object field to indicate what type of zone-based ticket pricing setup the organisation uses

• Switched apigee to point to new Organisations
• Fixed swagger url for developer portal
• Removed contact endpoint
  • GET {{organisations}}/contacts
  • GET {{organisations}}/organisations/{orgId}/contacts
  • PUT {{organisations}}/organisations/{orgId}/contacts
  • PUT {{organisations}}/organisations/{orgId}/contacts/{id}
  • DELETE {{organisations}}/organisations/{orgId}/contacts/{id}

Update helmchart api version

• deployment.yaml
  • apps/v1beta1 -> apps/v1
• ingress.yaml
  • extensions/v1beta1 -> networking.k8s.io/v1beta1