[Fiware-security] TR: [Fiware-wpl] Publication of specifications that are not APIs

[Wolfgang.Steigerwald at telekom.de]

Hello Pascal,

Can you provide a template for the API Specification? I had a  look on the OpenStack documentation, but the documentation varies from module to module.

Best regards

 Wolfgang

-----Ursprüngliche Nachricht-----
Von: fiware-security-bounces at lists.fi-ware.eu [mailto:fiware-security-bounces at lists.fi-ware.eu] Im Auftrag von DI CERBO, Francesco
Gesendet: Montag, 14. Mai 2012 18:39
An: BISSON Pascal; fiware-security at lists.fi-ware.eu
Betreff: Re: [Fiware-security] TR: [Fiware-wpl] Publication of specifications that are not APIs

Thanks Pascal,

I confirm that we started to act as proposed by Juanjo. As no template is foreseen, as previously mentioned and as indirectly confirmed in this email, we took a convenient and reasonable layout for our specification.

We will send an email as soon as the new wiki page(s) will be available.

Best regards

Francesco

> -----Original Message-----
> From: fiware-security-bounces at lists.fi-ware.eu 
> [mailto:fiware-security- bounces at lists.fi-ware.eu] On Behalf Of BISSON 
> Pascal
> Sent: lundi 14 mai 2012 13:55
> To: fiware-security at lists.fi-ware.eu
> Subject: [Fiware-security] TR: [Fiware-wpl] Publication of 
> specifications that are not APIs
> 
> FYI
> 
> @Slim/Francesco please use to treat USDL Specifications in the context 
> of D8.1a the way it has now been proposed by TID for what concerns 
> specifications which are not API specifications. Please confirm me and 
> Daniel once done.
> 
> BR
> Pascal
> 
> -----Message d'origine-----
> De : fiware-wpl-bounces at lists.fi-ware.eu [mailto:fiware-wpl- 
> bounces at lists.fi-ware.eu] De la part de Juanjo Hierro Envoyé : lundi 
> 14 mai 2012 08:37 À : fiware-wpl at lists.fi-ware.eu; 
> fiware-wpa at lists.fi-ware.eu Objet : [Fiware-wpl] Publication of 
> specifications that are not APIs
> 
> Hi all,
> 
>    During our last joint WPLs/WPAs follow-up confcall, a question was 
> raised regarding how to treat specifications that are not API
> specifications.   Examples of this are the USDL-sec specification
> produced by the Security chapter or the Context Modelling Language 
> (CML) to be supported by the high-level convenience API to be offered 
> by the Pub/Sub Broker GE (complementary to the FI-WARE NGSI API).
> 
>    Although I answered the question during the confcall, I summarize
> here the approach we propose to adopt.   The idea is pretty simple:
> these specifications are going to be treated the same way as API
> specifications.   I remind you that the approach that was decided
> implied that a new "Open Specifications" section will be added to the 
> wiki page linked to each GE within the FI-WARE Architecture section of 
> the public wiki (which will be retitled as FI-WARE Architecture and
> Specifications.   That section within a given GE description will
> include a list of ALL the relevant specifications (implemented as a 
> list of items, each pointing to the wiki page associated to one
> specification).    We will structure this section in two subsections
> "REST API specifications" and "Other specifications" so that each 
> specification will be placed in one of them.
> 
>    The wiki page associated to a given specification will be referenced
> from two places.   First, from the section titled "Open Specifications"
> linked to a given GE as explained above (note that several GEs may 
> establish a link to the same specification, as it happens with the NGSI
> specifications).   Second, from a wiki page we will titled "Summary of
> FI-WARE specifications" whose URL link will be referred from both the 
> main page of the FI-WARE Architecture wiki page as well as the home page
> of the FI-WARE public wiki.   This "Summary of FI-WARE specifications"
> will be work as an index of all FI-WARE specifications and will also 
> help us to generate a separate .pdf for just the Open Specifications.
> It will be further be structured in two main sections "REST API
> specifications" and "Other specifications".   The "REST API
> specifications" subsection will comprise a list of sections common to 
> all REST API specifications (as per agreements reached after 
> discussion on comments received by the Security chapter team) plus a 
> list of all the API specifications.
> 
>    Regarding development of contents in the private wiki, you just 
> need to produce a wiki page devoted to the specification you wish to 
> publish and include it in the placeholder for your chapter, the same way you
> have done with any API specification.   Detailed instructions on how to
> port these pages to the public wiki will be given before tomorrow noon.
> however, what I have described above anticipates the plan.
> 
>    More detailed info will be provided in the detailed instructions 
> that will be provided regarding how Open Specification contents will be
> ported from the private to the public wiki.   These detailed
> instructions will be available on the private wiki by tomorrow noon.
> 
>    Of course, any feedback/comments are welcome.
> 
>    Cheers,
> 
> -- Juanjo
> 
> -------------
> Product Development and Innovation (PDI) - Telefonica Digital
> website: www.tid.es
> email: jhierro at tid.es
> twitter: twitter.com/JuanjoHierro
> 
> FI-WARE (European Future Internet Core Platform) Chief Architect
> 
> You can follow FI-WARE at:
>    website:  http://www.fi-ware.eu
>    facebook: http://www.facebook.com/pages/FI-WARE/251366491587242
>    twitter:  http://twitter.com/FIware
>    linkedIn: http://www.linkedin.com/groups/FIWARE-4239932
> 
> 
> ________________________________
> 
> Este mensaje se dirige exclusivamente a su destinatario. Puede 
> consultar nuestra política de envío y recepción de correo electrónico 
> en el enlace situado más abajo.
> This message is intended exclusively for its addressee. We only send 
> and receive email on the basis of the terms set out at.
> http://www.tid.es/ES/PAGINAS/disclaimer.aspx
> _______________________________________________
> Fiware-wpl mailing list
> Fiware-wpl at lists.fi-ware.eu
> http://lists.fi-ware.eu/listinfo/fiware-wpl
> _______________________________________________
> Fiware-security mailing list
> Fiware-security at lists.fi-ware.eu
> http://lists.fi-ware.eu/listinfo/fiware-security
_______________________________________________
Fiware-security mailing list
Fiware-security at lists.fi-ware.eu
http://lists.fi-ware.eu/listinfo/fiware-security