Commit 3267a2b6 authored by Linda Toth's avatar Linda Toth
Browse files

Replace readme, remove license files (this project has the notices in the docs)

parent 2fdd0353
Creative Commons Attribution 4.0 International Public License
By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution 4.0 International Public License ("Public License"). To the
extent this Public License may be interpreted as a contract, You are
granted the Licensed Rights in consideration of Your acceptance of
these terms and conditions, and the Licensor grants You such rights in
consideration of benefits the Licensor receives from making the
Licensed Material available under these terms and conditions.
Section 1 -- Definitions.
a. Adapted Material means material subject to Copyright and Similar
Rights that is derived from or based upon the Licensed Material
and in which the Licensed Material is translated, altered,
arranged, transformed, or otherwise modified in a manner requiring
permission under the Copyright and Similar Rights held by the
Licensor. For purposes of this Public License, where the Licensed
Material is a musical work, performance, or sound recording,
Adapted Material is always produced where the Licensed Material is
synched in timed relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.
c. Copyright and Similar Rights means copyright and/or similar rights
closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or
categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
Rights.
d. Effective Technological Measures means those measures that, in the
absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright
Treaty adopted on December 20, 1996, and/or similar international
agreements.
e. Exceptions and Limitations means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.
f. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
License.
g. Licensed Rights means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to
all Copyright and Similar Rights that apply to Your use of the
Licensed Material and that the Licensor has authority to license.
h. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.
i. Share means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the
public may access the material from a place and at a time
individually chosen by them.
j. Sui Generis Database Rights means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
as amended and/or succeeded, as well as other essentially
equivalent rights anywhere in the world.
k. You means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.
Section 2 -- Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License,
the Licensor hereby grants You a worldwide, royalty-free,
non-sublicensable, non-exclusive, irrevocable license to
exercise the Licensed Rights in the Licensed Material to:
a. reproduce and Share the Licensed Material, in whole or
in part; and
b. produce, reproduce, and Share Adapted Material.
2. Exceptions and Limitations. For the avoidance of doubt, where
Exceptions and Limitations apply to Your use, this Public
License does not apply, and You do not need to comply with
its terms and conditions.
3. Term. The term of this Public License is specified in Section
6(a).
4. Media and formats; technical modifications allowed. The
Licensor authorizes You to exercise the Licensed Rights in
all media and formats whether now known or hereafter created,
and to make technical modifications necessary to do so. The
Licensor waives and/or agrees not to assert any right or
authority to forbid You from making technical modifications
necessary to exercise the Licensed Rights, including
technical modifications necessary to circumvent Effective
Technological Measures. For purposes of this Public License,
simply making modifications authorized by this Section 2(a)
(4) never produces Adapted Material.
5. Downstream recipients.
a. Offer from the Licensor -- Licensed Material. Every
recipient of the Licensed Material automatically
receives an offer from the Licensor to exercise the
Licensed Rights under the terms and conditions of this
Public License.
b. No downstream restrictions. You may not offer or impose
any additional or different terms or conditions on, or
apply any Effective Technological Measures to, the
Licensed Material if doing so restricts exercise of the
Licensed Rights by any recipient of the Licensed
Material.
6. No endorsement. Nothing in this Public License constitutes or
may be construed as permission to assert or imply that You
are, or that Your use of the Licensed Material is, connected
with, or sponsored, endorsed, or granted official status by,
the Licensor or others designated to receive attribution as
provided in Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not
licensed under this Public License, nor are publicity,
privacy, and/or other similar personality rights; however, to
the extent possible, the Licensor waives and/or agrees not to
assert any such rights held by the Licensor to the limited
extent necessary to allow You to exercise the Licensed
Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this
Public License.
3. To the extent possible, the Licensor waives any right to
collect royalties from You for the exercise of the Licensed
Rights, whether directly or through a collecting society
under any voluntary or waivable statutory or compulsory
licensing scheme. In all other cases the Licensor expressly
reserves any right to collect such royalties.
Section 3 -- License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the
following conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified
form), You must:
a. retain the following if it is supplied by the Licensor
with the Licensed Material:
i. identification of the creator(s) of the Licensed
Material and any others designated to receive
attribution, in any reasonable manner requested by
the Licensor (including by pseudonym if
designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of
warranties;
v. a URI or hyperlink to the Licensed Material to the
extent reasonably practicable;
b. indicate if You modified the Licensed Material and
retain an indication of any previous modifications; and
c. indicate the Licensed Material is licensed under this
Public License, and include the text of, or the URI or
hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any
reasonable manner based on the medium, means, and context in
which You Share the Licensed Material. For example, it may be
reasonable to satisfy the conditions by providing a URI or
hyperlink to a resource that includes the required
information.
3. If requested by the Licensor, You must remove any of the
information required by Section 3(a)(1)(A) to the extent
reasonably practicable.
4. If You Share Adapted Material You produce, the Adapter's
License You apply must not prevent recipients of the Adapted
Material from complying with this Public License.
Section 4 -- Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that
apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
to extract, reuse, reproduce, and Share all or a substantial
portion of the contents of the database;
b. if You include all or a substantial portion of the database
contents in a database in which You have Sui Generis Database
Rights, then the database in which You have Sui Generis Database
Rights (but not its individual contents) is Adapted Material; and
c. You must comply with the conditions in Section 3(a) if You Share
all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
c. The disclaimer of warranties and limitation of liability provided
above shall be interpreted in a manner that, to the extent
possible, most closely approximates an absolute disclaimer and
waiver of all liability.
Section 6 -- Term and Termination.
a. This Public License applies for the term of the Copyright and
Similar Rights licensed here. However, if You fail to comply with
this Public License, then Your rights under this Public License
terminate automatically.
b. Where Your right to use the Licensed Material has terminated under
Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided
it is cured within 30 days of Your discovery of the
violation; or
2. upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any
right the Licensor may have to seek remedies for Your violations
of this Public License.
c. For the avoidance of doubt, the Licensor may also offer the
Licensed Material under separate terms or conditions or stop
distributing the Licensed Material at any time; however, doing so
will not terminate this Public License.
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
License.
Section 7 -- Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different
terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the
Licensed Material not stated herein are separate from and
independent of the terms and conditions of this Public License.
Section 8 -- Interpretation.
a. For the avoidance of doubt, this Public License does not, and
shall not be interpreted to, reduce, limit, restrict, or impose
conditions on any use of the Licensed Material that could lawfully
be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is
deemed unenforceable, it shall be automatically reformed to the
minimum extent necessary to make it enforceable. If the provision
cannot be reformed, it shall be severed from this Public License
without affecting the enforceability of the remaining terms and
conditions.
c. No term or condition of this Public License will be waived and no
failure to comply consented to unless expressly agreed to by the
Licensor.
d. Nothing in this Public License constitutes or may be interpreted
as a limitation upon, or waiver of, any privileges and immunities
that apply to the Licensor or You, including from the legal
processes of any jurisdiction or authority.
=======================================================================
Creative Commons is not a party to its public
licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
will be considered the “Licensor.” The text of the Creative Commons
public licenses is dedicated to the public domain under the CC0 Public
Domain Dedication. Except for the limited purpose of indicating that
material is shared under a Creative Commons public license or as
otherwise permitted by the Creative Commons policies published at
creativecommons.org/policies, Creative Commons does not authorize the
use of the trademark "Creative Commons" or any other trademark or logo
of Creative Commons without its prior written consent including,
without limitation, in connection with any unauthorized modifications
to any of its public licenses or any other arrangements,
understandings, or agreements concerning use of licensed material. For
the avoidance of doubt, this paragraph does not form part of the
public licenses.
Creative Commons may be contacted at creativecommons.org.
# Conexxus and IFSF License
## The content (content being images, text or any other medium contained within this document which is eligible of copyright protection) are jointly copyrighted by Conexxus and IFSF. All rights are expressly reserved.
## IF YOU ACQUIRE THIS DOCUMENT FROM IFSF. THE FOLLOWING STATEMENT ON THE USE OF COPYRIGHTED MATERIAL APPLIES:
You may print or download to a local hard disk extracts for your own business use. Any other redistribution or reproduction of part or all of the contents in any form is prohibited.
You may not, except with our express written permission, distribute to any third party. Where permission to distribute is granted by IFSF, the material must be acknowledged as IFSF copyright and the document title specified. Where third party material has been identified, permission from the respective copyright holder must be sought.
You agree to abide by all copyright notices and restrictions attached to the content and not to remove or alter any such notice or restriction.
Subject to the following paragraph, you may design, develop and offer for sale products which embody the functionality described in this document.
No part of the content of this document may be claimed as the Intellectual property of any organisation other than IFSF Ltd, and you specifically agree not to claim patent rights or other IPR protection that relates to:
the content of this document; or
any design or part thereof that embodies the content of this document whether in whole or part.
For further copies and amendments to this document please contact: IFSF Technical Services via the IFSF Web Site (www.ifsf.org).
## IF YOU ACQUIRE THIS DOCUMENT FROM CONEXXUS, THE FOLLOWING STATEMENT ON THE USE OF COPYRIGHTED MATERIAL APPLIES:
Conexxus members may use this document for purposes consistent with the adoption of the Conexxus Standard (and/or the related documentation); however, Conexxus must pre-approve any inconsistent uses in writing.
Conexxus recognizes that a Member may wish to create a derivative work that comments on, or otherwise explains or assists in implementation, including citing or referring to the standard, specification, protocol, schema, or guideline, in whole or in part. The Member may do so, but may share such derivative work ONLY with another Conexxus Member who possesses appropriate document rights (i.e., Gold or Silver Members) or with a direct contractor who is responsible for implementing the standard for the Member. In so doing, a Conexxus Member should require its development partners to download Conexxus documents and schemas directly from the Conexxus website. A Conexxus Member may not furnish this document in any form, along with any derivative works, to non-members of Conexxus or to Conexxus Members who do not possess document rights (i.e., Bronze Members) or who are not direct contractors of the Member. A Member may demonstrate its Conexxus membership at a level that includes document rights by presenting an unexpired digitally signed Conexxus membership certificate.
This document may not be modified in any way, including removal of the copyright notice or references to Conexxus. However, a Member has the right to make draft changes to schema for trial use before submission to Conexxus for consideration to be included in the existing standard. Translations of this document into languages other than English shall continue to reflect the Conexxus copyright notice.
The limited permissions granted above are perpetual and will not be revoked by Conexxus, Inc. or its successors or assigns, except in the circumstance where an entity, who is no longer a member in good standing but who rightfully obtained Conexxus Standards as a former member, is acquired by a non-member entity. In such circumstances, Conexxus may revoke the grant of limited permissions or require the acquiring entity to establish rightful access to Conexxus Standards through membership.
# API Design Guidelines
This project contains documents that define the Conexxus/IFSF API Design Guidelines.
## Introduction
Conexxus and IFSF have worked with retailer and supplier (developer) members to assemble a set of documents to describe how to create an API for consideration as an industry standard. While there are many languages, formats, and tools available to create APIs, Conexxus and IFSF are focussing on those that are most standardized, and most likely to be useful in a variety of the environments in Convenience Retail computing.
* If the project is within the *Work in Progress* group, it contains Microsoft word documents, and the changes for any given development branch will be presented in "track changes" mode.
* If the project is within the *Public Standards* group. it contains the pdf versions of the documents.
## Rationale for Selections
Specifically, the participants have singled out the following tools and standards as having the broadest scope:
- Open API Specification 3.0 - formerly "Swagger," this API definition format has become the de facto standard for APIs.
- JSON-Schema 0.7 - as standards organizations, we require a way to define and compose message content. JSON-Schema is the emerging standard in JSON family of tools, and is compatible with OAS 3.0.
- HTML5 - Capabilities in HTML are ubiquitous, and are included in almost all server and client side development environments.
## Documents
### [API Design Rules for JSON](https://gitlab.openretailing.org/public-standards/api-design-guidelines/blob/master/Open%20Retailing%20API%20Design%20Rules%20for%20JSON.pdf)
## Guides in this Project
The guides fall into the following categories:
This document describes the Open Retailing (fuel retailing and convenience store) style guidelines for the use of JSON based APIs, including property and object naming conventions. These guidelines are based on best practice gleaned from IFSF, Conexxus, OMG (IXRetail), W3C, Amazon, Open API Standard and other industry bodies.
### Design Rules
1. **[Open Retailing API Design Rules for JSON](Open%20Retailing%20API%20Design%20Rules%20for%20JSON.docx)**
This guide covers naming of properties, use of booleans, and other basic design topics.
### [API Implementation Guide - Security](https://gitlab.openretailing.org/public-standards/api-design-guidelines/blob/master/Open%20Retailing%20API%20Implementation%20Guide%20-%20Security.pdf)
2. **[Open Retailing Design Rules for APIs OAS3.0](Open%20Retailing%20Design%20Rules%20for%20APIs%20OAS3.0.docx)**
Topics in this guide describe how to define an API (using the API Definition File (ADF), written in YAML), expected directory layouts, and other important topics.
This document describes the Fuel Retailing and Convenience Store API implementation guidelines for security.
3. **[Open Retailing Implementation Guide - Security](Open%20Retailing%20API%20Implementation%20Guide%20-%20Security.docx)**
This guide breaks out security considerations into a separate document. Since ideas about security tend to change relatively rapidly, having this guide in a separate document makes the rest of the documents more stable.
### [API Implementation Guide - Transport Alternatives](https://gitlab.openretailing.org/public-standards/api-design-guidelines/blob/master/Open%20Retailing%20API%20Implementation%20Guide%20-%20Transport%20Alternatives.pdf)
This document describes the Fuel Retailing and Convenience Store transport layer alternatives for RESTful web services carrying JSON based APIs, as well as some justification for the selections made.
4. **[Open Retailing Implementation Guide - Transport Alternatives](Open%20Retailing%20API%20Implementation%20Guide%20-%20Transport%20Alternatives.docx)**
Transport alternatives include web sockets, native (TCP/IP) sockets, MQTT, AMQP, etc. This document explains the current design choices for the API work and how that might change in the future, depending on changes to the cloud coding conventional wisdom.
### [Design Rules for APIs OAS 3.0](https://gitlab.openretailing.org/public-standards/api-design-guidelines/blob/master/Open%20Retailing%20Design%20Rules%20for%20APIs%20OAS3.0.pdf)
This document describes the Open Retailing (fuel retailing and convenience store) style guidelines for the use of RESTful Web Service APIs, specifically the use of the OAS3.0 file format and referencing of relevant JSON Schemas from that file. These guidelines are based on best practice gleaned from OMG (IXRetail), W3C, Amazon, Open API Standard and other industry bodies.
These guidelines are not to be considered a primer for how to create APIs. There are thousands of documents and blog posts about APIs and best-practices for creating them. This guide is rather a set of practices to serve as “guardrails” to ensure that Open Retailing APIs have a consistent design
### [Joint API Data Dictionary (proposed)](https://gitlab.openretailing.org/public-proposed-standards/api-data-dictionary)
This is the API Data Dictionary (“Dictionary”), jointly owned by the IFSF (www.ifsf.org) and Conexxus (www.conexxus.org), and shared in order to assist in the use of our international standards. The Dictionary is open to the public and everybody is allowed to use them. For example, we expect many users will find the Dictionary helpful to understand fuel retailing and to define further innovative and collaborative APIs.
### API Webinars
Each month Conexxus hosts complimentary public webinars on a variety of topics, including webinars on APIs. Please visit our Webinar Library to view recordings and upcoming webinars, which can be filtered by topic.
### More information
If you have comments, or would like us to consider changes to any of these items, please either open an issue (in GitLab) or email support@openretailing.org.
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment