From dev-return-15056-archive-asf-public=cust-asf.ponee.io@syncope.apache.org Thu Feb 15 12:33:04 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id 470E418064A for ; Thu, 15 Feb 2018 12:33:04 +0100 (CET) Received: (qmail 12864 invoked by uid 500); 15 Feb 2018 11:33:03 -0000 Mailing-List: contact dev-help@syncope.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@syncope.apache.org Delivered-To: mailing list dev@syncope.apache.org Received: (qmail 12853 invoked by uid 99); 15 Feb 2018 11:33:03 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd4-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 15 Feb 2018 11:33:03 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd4-us-west.apache.org (ASF Mail Server at spamd4-us-west.apache.org) with ESMTP id A0903C0238 for ; Thu, 15 Feb 2018 11:33:02 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -109.511 X-Spam-Level: X-Spam-Status: No, score=-109.511 tagged_above=-999 required=6.31 tests=[ENV_AND_HDR_SPF_MATCH=-0.5, KAM_ASCII_DIVIDERS=0.8, RCVD_IN_DNSWL_MED=-2.3, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01, USER_IN_DEF_SPF_WL=-7.5, USER_IN_WHITELIST=-100] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd4-us-west.apache.org [10.40.0.11]) (amavisd-new, port 10024) with ESMTP id 2A_tHAWNm-EY for ; Thu, 15 Feb 2018 11:33:01 +0000 (UTC) Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org [209.188.14.139]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with ESMTP id 15A305F286 for ; Thu, 15 Feb 2018 11:33:01 +0000 (UTC) Received: from jira-lw-us.apache.org (unknown [207.244.88.139]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id 510E3E00A6 for ; Thu, 15 Feb 2018 11:33:00 +0000 (UTC) Received: from jira-lw-us.apache.org (localhost [127.0.0.1]) by jira-lw-us.apache.org (ASF Mail Server at jira-lw-us.apache.org) with ESMTP id 14B0E21E59 for ; Thu, 15 Feb 2018 11:33:00 +0000 (UTC) Date: Thu, 15 Feb 2018 11:33:00 +0000 (UTC) From: "ASF subversion and git services (JIRA)" To: dev@syncope.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Commented] (SYNCOPE-1274) Report required and read-only payload properties in OpenApi spec MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/SYNCOPE-1274?page=3Dcom.atlassi= an.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=3D16= 365420#comment-16365420 ]=20 ASF subversion and git services commented on SYNCOPE-1274: ---------------------------------------------------------- Commit ec7571f4eb96549c070e37be782bb137c437267c in syncope's branch refs/he= ads/2_0_X from [~ilgrosso] [ https://git-wip-us.apache.org/repos/asf?p=3Dsyncope.git;h=3Dec7571f ] [SYNCOPE-1274] Adding documentation for request / response additional heade= rs > Report required and read-only payload properties in OpenApi spec > ---------------------------------------------------------------- > > Key: SYNCOPE-1274 > URL: https://issues.apache.org/jira/browse/SYNCOPE-1274 > Project: Syncope > Issue Type: Improvement > Components: common > Affects Versions: 2.0.7 > Reporter: Francesco Chicchiricc=C3=B2 > Assignee: Francesco Chicchiricc=C3=B2 > Priority: Major > Labels: openapi, swagger > Fix For: 2.0.8, 2.1.0 > > Attachments: model-after.png, model-before.png > > > The OpenApi spec is currently missing any required and read-only informat= ion about payload properties. > For example, the {{POST /users}} endpoint reports the following sample va= lue: > {code:java} > { > "creator": "string", > "creationDate": "2018-02-11T14:19:38.905Z", > "lastModifier": "string", > "lastChangeDate": "2018-02-11T14:19:38.905Z", > "key": "string", > "type": "string", > "realm": "string", > "status": "string", > "password": "string", > "token": "string", > "tokenExpireTime": "2018-02-11T14:19:38.905Z", > "username": "string", > "lastLoginDate": "2018-02-11T14:19:38.905Z", > "changePwdDate": "2018-02-11T14:19:38.905Z", > "failedLogins": 0, > "securityQuestion": "string", > "securityAnswer": "string", > "suspended": true, > "mustChangePassword": true > } > {code} > which should be better instead > {code:java} > { > "realm": "string", > "@class": "org.apache.syncope.common.lib.to.UserTO", > "password": "string", > "username": "string", > "securityQuestion": "string", > "securityAnswer": "string" > } > {code} > (also note the Jackson's {{@class}} management). > Similar for models (see attachments as samples). -- This message was sent by Atlassian JIRA (v7.6.3#76005)