Platform of Trust Platform Design Guide
Developer PortalAPI DocsOntology
  • Purpose and scope
  • Developer eXperience Strategy
  • Suggest changes
  • API Requests
    • Request validation
    • Response codes used
    • Error handling
  • General API guidelines
    • Performance
    • Documentation
    • Data models used
    • Use HATEOAS
    • Use HTTP Methods
    • Dates and time
    • Naming conventions
    • Pagination, partial response and sorting
    • API Testing
  • API Headers
    • Mandatory elements & behaviour
    • Rate limiting information
  • API Security
    • Authentication and authorization
    • SSL everywhere - all the time
  • API versioning guidelines
    • Versioning Rules
    • Breaking changes
    • Non-breaking changes example
    • Retirement process
    • Add new API to documentation
    • Add new endpoint
  • API Migration Policies
    • Deprecating API
    • Sunsetting API
    • Blackout Testing
    • Migration Email Template
    • API Blackout Test Email Template
    • API Deprecation Email
    • Deprecating an older API
  • Ontologies
    • About ontologies
    • Web Ontology Language, OWL
    • Ontology editor
    • Edit ontology
    • Add new subclass
    • Naming convention logic
    • Extending the ontology
  • Design Guideline
    • Colors
    • Typography
    • Grids and Space
    • Input forms - Text field
    • Input forms - Text area
    • Buttons
    • Checkbox
    • Radio buttons
    • Date picker
    • Form control - Single select
    • Toggle
    • Pagination
    • Status pills
    • Tables
    • Effects
    • Dialogues
Powered by GitBook
On this page
  • Non-breaking changes regarding APIs
  • Non-breaking changes regarding ontology
  • Adding/changing annotation information
  • Adding classes
  • Adding properties

Was this helpful?

  1. API versioning guidelines

Non-breaking changes example

Non-breaking changes regarding APIs

• Making a required field in the request to be optional, without affecting any of the logic when the field is used • Adding an optional request field that does not affect the response logic when the field is not present • Correcting an issue with the backend logic that does not result if any of the updates listed in “Breaking changes” • Adding a new feature that does not results in any of the updates listed in “Breaking changes” • Creating a new endpoint that does not results in any of the updates listed in “Breaking changes” • Adding a new resource to an existing endpoint that does not results in any of the updates listed in “Breaking changes”

Non-breaking changes regarding ontology

Adding/changing annotation information

Adding annotation properties like labels, descriptions, links between classes e.t.c. This will not affect Context URLs structure and class names and those should not affect or break any logic.

Adding classes

Adding new classes to ontology and defining their properties should not break existing logic because there should be no references to new things in existing code.

Adding properties

Adding new properties to ontology itself is not a breaking change. However linking them to classes might be breaking change if this property is required, since existing data needs to be updated.

PreviousBreaking changesNextRetirement process

Last updated 4 years ago

Was this helpful?