Skip to content

Commit

Permalink
Merge pull request #51 from RealEstateCore/hotfix-3.1.2
Browse files Browse the repository at this point in the history
Hotfix 3.1.2 -- API bugfixes
  • Loading branch information
hammar authored May 14, 2020
2 parents 88d4165 + ce16556 commit 1ce5ea3
Show file tree
Hide file tree
Showing 15 changed files with 1,494 additions and 985 deletions.
10 changes: 10 additions & 0 deletions ReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# RealEstateCore Release Notes

## V3.1.2 -- REST API Hotfix

Version 3.1.2 is a bug fix release that addresses two issues in the REST API specification, and one in the edge message format:

* The REC REST API specification now specifies that the payload for POST, PUT, and PATCH operations should be carried in the HTTP request body.
* The REC REST API specification now uses the updated MIME type for JSON-LD: application/ld+json
* The Edge message examples mistakenly carried REC 2 semantics due to previous Git mishap; that is now addressed and the examples are up-to-date

Note that this hotfix does not affect the ontology semantics; aside from version and release node annotations, REC 3.1.2 is identical to REC 3.1.2.

## V3.1.1 -- REST API

Version 3.1.1 is a minor release of REC that contains:
Expand Down
4 changes: 2 additions & 2 deletions api/REST/RealEstateCore_REST_specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ _This specification defines the first version of the RealEstateCore REST API._

_It comprises a non-normative section where principles for the REST API is described. And a normative section where requirements for being and API to be "RealEstateCore Compliant" are stated._

_Formally, the API is specified via an Open API Specification (formerly Swagger API) generated from the OWL ontology, and from which the normative requirements section below stems. See [OAS Spec](https://github.com/RealEstateCore/rec/blob/3.1.1/api/REST/rec-full-v3.1.1.yaml)._
_Formally, the API is specified via an Open API Specification (formerly Swagger API) generated from the OWL ontology, and from which the normative requirements section below stems. See [OAS Spec](https://github.com/RealEstateCore/rec/blob/3.1.2/api/REST/rec-full-v3.1.2.yaml)._

_Throughout this specification RealEstateCore may be abbreviated to REC._

Expand All @@ -29,7 +29,7 @@ Additional functionality may be implemented and a mechanism to understanding suc

**Principle.** In addition to the minimum set of requirements, the specification comprises optional requirements which must be followed _if chosen to be included_ in an API implementation (designated _"should"_).

![Requirement Diagram](https://github.com/RealEstateCore/rec/blob/3.1.1/api/REST/REC_API_Requirement_diagram.png)
![Requirement Diagram](https://github.com/RealEstateCore/rec/blob/3.1.2/api/REST/REC_API_Requirement_diagram.png)

Furthermore, recommendations are expressed for areas where the REC Consortium considers to add requirements in the future.

Expand Down
Loading

0 comments on commit 1ce5ea3

Please sign in to comment.