Core API wording: rename CompositeValue

[jri]

While explaining the Core API to others it became evident that the class CompositeValue and its accompanying composite JSON property and fetch_composite query parameters are named badly. What a CompositeValue object actually represents is a set of child topics. So the following renamings should be applied. Goal is to make the Core API more intuitive.

Classes/Interfaces?:

CompositeValue -> ChildTopics
CompositeValueModel -> ChildTopicsModel

JSON property:

composite -> childs

Query parameters:

fetch_composite -> include_childs
fetch_relating_composite -> include_assoc_childs

[Jörg Richter]

Core API wording: rename CompValue? pt.1 (#702).

BREAKING CHANGES

Classes/Interfaces?:

CompositeValue -> ChildTopics
    getCompositeValue() -> getChildTopics()
CompositeValueModel -> ChildTopicsModel
    getCompositeValueModel() -> getChildTopicsModel()

DeepaMehtaObject?:

getCompositeValue() -> getChildTopics()
setCompositeValue() -> setChildTopics()

DeepaMehtaObjectModel?:

getCompositeValueModel() -> getChildTopicsModel()
setCompositeValue() -> setChildTopicsModel()

See #702.

• Changeset: e59f193705435c4439c8f384dea404783acf771f
• URL: ​https://github.com/jri/deepamehta/commit/e59f193705435c4439c8f384dea404783acf771f

[Jörg Richter]

Core API wording: rename CompValue? pt.2 (#702).

BREAKING CHANGE

The topic/association's JSON property composite is renamed to childs.

{
    "id": ..,
    "uri": ..,
    "type_uri": ..,
    "value": ..,
    "childs": ..    ### was "composite"
}

Plugin developers are supposed to carefully update the JSON migrations and client-side code.

See #702.

• Changeset: b433fd46912fd0a5c32e3fb7a8e5a2d68f4e01d0
• URL: ​https://github.com/jri/deepamehta/commit/b433fd46912fd0a5c32e3fb7a8e5a2d68f4e01d0

[Jörg Richter]

Core API wording: rename CompValue? pt.3 (#702).

BREAKING CHANGE

REST APIs: the fetch_composite query parameter is renamed to include_childs.

Example:

GET /core/topic/1234?include_childs=true    ### "include_childs" was "fetch_composite"

Plugin developers are supposed to carefully update client-side code.

NOTE: the former fetch_relating_composite query parameter to include the (relating) association's child topics in the response is not supported at the moment. Do we actually need it in the REST APIs? If so, it should be renamed to include_assoc_childs and be implemented in the Core's JerseyResponseFilter (analogous to include_childs).

See #702.

• Changeset: 6f7594fdeb7007cccf6ed311d61a4edfccff4839
• URL: ​https://github.com/jri/deepamehta/commit/6f7594fdeb7007cccf6ed311d61a4edfccff4839

[Jörg Richter]

Core API wording: rename CompValue? pt.4 (#702).

Just rename variables and adapt comments.

See #702.

• Changeset: 144816ced8a96ec575c86d6fca45964440b7a7b5
• URL: ​https://github.com/jri/deepamehta/commit/144816ced8a96ec575c86d6fca45964440b7a7b5

[Jörg Richter]

Core API wording: rename CompValue? pt.1 (#702).

BREAKING CHANGES

Classes/Interfaces?:

CompositeValue -> ChildTopics
    getCompositeValue() -> getChildTopics()
CompositeValueModel -> ChildTopicsModel
    getCompositeValueModel() -> getChildTopicsModel()

DeepaMehtaObject?:

getCompositeValue() -> getChildTopics()
setCompositeValue() -> setChildTopics()

DeepaMehtaObjectModel?:

getCompositeValueModel() -> getChildTopicsModel()
setCompositeValue() -> setChildTopicsModel()

See #702.

• Changeset: e59f193705435c4439c8f384dea404783acf771f
• URL: ​https://github.com/jri/deepamehta/commit/e59f193705435c4439c8f384dea404783acf771f

[Jörg Richter]

Core API wording: rename CompValue? pt.2 (#702).

BREAKING CHANGE

The topic/association's JSON property composite is renamed to childs.

{
    "id": ..,
    "uri": ..,
    "type_uri": ..,
    "value": ..,
    "childs": ..    ### was "composite"
}

Plugin developers are supposed to carefully update the JSON migrations and client-side code.

See #702.

• Changeset: b433fd46912fd0a5c32e3fb7a8e5a2d68f4e01d0
• URL: ​https://github.com/jri/deepamehta/commit/b433fd46912fd0a5c32e3fb7a8e5a2d68f4e01d0

[Jörg Richter]

Core API wording: rename CompValue? pt.3 (#702).

BREAKING CHANGE

REST APIs: the fetch_composite query parameter is renamed to include_childs.

Example:

GET /core/topic/1234?include_childs=true    ### "include_childs" was "fetch_composite"

Plugin developers are supposed to carefully update client-side code.

NOTE: the former fetch_relating_composite query parameter to include the (relating) association's child topics in the response is not supported at the moment. Do we actually need it in the REST APIs? If so, it should be renamed to include_assoc_childs and be implemented in the Core's JerseyResponseFilter (analogous to include_childs).

See #702.

• Changeset: 6f7594fdeb7007cccf6ed311d61a4edfccff4839
• URL: ​https://github.com/jri/deepamehta/commit/6f7594fdeb7007cccf6ed311d61a4edfccff4839

[Jörg Richter]

Core API wording: rename CompValue? pt.4 (#702).

Just rename variables and adapt comments.

See #702.

• Changeset: 144816ced8a96ec575c86d6fca45964440b7a7b5
• URL: ​https://github.com/jri/deepamehta/commit/144816ced8a96ec575c86d6fca45964440b7a7b5

[Jörg Richter]

Core API wording: rename CompValue? pt.1 (#702).

BREAKING CHANGES

Classes/Interfaces?:

CompositeValue -> ChildTopics
    getCompositeValue() -> getChildTopics()
CompositeValueModel -> ChildTopicsModel
    getCompositeValueModel() -> getChildTopicsModel()

DeepaMehtaObject?:

getCompositeValue() -> getChildTopics()
setCompositeValue() -> setChildTopics()

DeepaMehtaObjectModel?:

getCompositeValueModel() -> getChildTopicsModel()
setCompositeValue() -> setChildTopicsModel()

See #702.

• Changeset: e59f193705435c4439c8f384dea404783acf771f
• URL: ​https://github.com/jri/deepamehta/commit/e59f193705435c4439c8f384dea404783acf771f

[Jörg Richter]

Core API wording: rename CompValue? pt.2 (#702).

BREAKING CHANGE

The topic/association's JSON property composite is renamed to childs.

{
    "id": ..,
    "uri": ..,
    "type_uri": ..,
    "value": ..,
    "childs": ..    ### was "composite"
}

Plugin developers are supposed to carefully update the JSON migrations and client-side code.

See #702.

• Changeset: b433fd46912fd0a5c32e3fb7a8e5a2d68f4e01d0
• URL: ​https://github.com/jri/deepamehta/commit/b433fd46912fd0a5c32e3fb7a8e5a2d68f4e01d0

[Jörg Richter]

Core API wording: rename CompValue? pt.3 (#702).

BREAKING CHANGE

REST APIs: the fetch_composite query parameter is renamed to include_childs.

Example:

GET /core/topic/1234?include_childs=true    ### "include_childs" was "fetch_composite"

Plugin developers are supposed to carefully update client-side code.

NOTE: the former fetch_relating_composite query parameter to include the (relating) association's child topics in the response is not supported at the moment. Do we actually need it in the REST APIs? If so, it should be renamed to include_assoc_childs and be implemented in the Core's JerseyResponseFilter (analogous to include_childs).

See #702.

• Changeset: 6f7594fdeb7007cccf6ed311d61a4edfccff4839
• URL: ​https://github.com/jri/deepamehta/commit/6f7594fdeb7007cccf6ed311d61a4edfccff4839

[Jörg Richter]

Core API wording: rename CompValue? pt.4 (#702).

Just rename variables and adapt comments.

See #702.

• Changeset: 144816ced8a96ec575c86d6fca45964440b7a7b5
• URL: ​https://github.com/jri/deepamehta/commit/144816ced8a96ec575c86d6fca45964440b7a7b5