Juniper Openstack

Document schema and generated API documentation

Bug #1554139 reported by Hampapur Ajay on 2016-03-07

This bug affects 1 person

	Status	Importance	Assigned to	Milestone
Juniper Openstack	Status tracked in Trunk
R3.0	Fix Committed	Medium	Hampapur Ajay
R3.1	Fix Committed	Medium	Hampapur Ajay
R3.2	Fix Committed	Medium	Hampapur Ajay	Juniper Openstack r3.2.0.0-fcs "r3.2.0.0"
Trunk	Fix Committed	Medium	Hampapur Ajay	Juniper Openstack r4.0.0.0-fcs "r4.0.0.0"

Bug Description

It is necessary to have description of the different types and elements in schema used by Contrail Virtual Networking system. The
generator system (contrail-generateDS) can be extended to produce API documentation from such a documented schema.

Tags:

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-03-07: [Review update] master

Review in progress for https://review.opencontrail.org/18226
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-03-08: A change has been merged

Reviewed: https://review.opencontrail.org/18226
Committed: http://github.org/Juniper/contrail-generateDS/commit/3d8e2cc5b49eee4fcdaa61e1ab3d96e3b2fd1a4f
Submitter: Zuul
Branch: master

commit 3d8e2cc5b49eee4fcdaa61e1ab3d96e3b2fd1a4f
Author: Hampapur Ajay <email address hidden>
Date: Mon Mar 7 09:27:59 2016 -0800

Absorb documentation hints for required/operations and any future
ones in idl_parser.

Change-Id: I5734a0c66b6216c5dca40e69b2acab99fdb71f33
Partial-Bug: 1554139

Changed in juniperopenstack:
milestone:	none → r3.1.0.0-fcs

Nagabhushana R (bhushana) on 2016-03-08

tags:

added: config

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-03-22: [Review update] master

Review in progress for https://review.opencontrail.org/18634
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-03-26: A change has been merged

Reviewed: https://review.opencontrail.org/18634
Committed: http://github.org/Juniper/contrail-generateDS/commit/4514eac74c79fb65918425e688566ece2475d7db
Submitter: Zuul
Branch: master

commit 4514eac74c79fb65918425e688566ece2475d7db
Author: Hampapur Ajay <email address hidden>
Date: Mon Mar 7 09:27:59 2016 -0800

Add support for documentation related tags in schema definition.

Change-Id: Ib280d8d12abe4892aaee36b58d6d7ef072078445
Partial-Bug: 1554139

Hampapur Ajay (hajay) on 2016-03-28

information type:

Proprietary → Public

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-03-28: [Review update] master

Review in progress for https://review.opencontrail.org/18824
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-03-31:

#13

Review in progress for https://review.opencontrail.org/18967
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-04-02: A change has been merged

#14

Reviewed: https://review.opencontrail.org/18967
Committed: http://github.org/Juniper/contrail-generateDS/commit/5984cdc69b8d03f5c09a7ce7a91d3b1470ae3754
Submitter: Zuul
Branch: master

commit 5984cdc69b8d03f5c09a7ce7a91d3b1470ae3754
Author: Hampapur Ajay <email address hidden>
Date: Thu Mar 31 15:35:04 2016 -0700

Support multi-line description.* tag and generate such ones from
restriction base'd types.

Change-Id: I3e9429fb6a0f5ee126480cc4686f3d970cb15b62
Partial-Bug: 1554139

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-04-03: [Review update] master

#15

Review in progress for https://review.opencontrail.org/18824
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-04-03: A change has been merged

#16

Reviewed: https://review.opencontrail.org/18824
Committed: http://github.org/Juniper/contrail-controller/commit/459353c6d34df19e3c9e8c535f2fd024b700b73d
Submitter: Zuul
Branch: master

commit 459353c6d34df19e3c9e8c535f2fd024b700b73d
Author: Hampapur Ajay <email address hidden>
Date: Mon Mar 28 11:18:36 2016 -0700

Documenting schema to indicate allowed operations, whether system/user
is creator and description. Diffs from hnakil@.

Change-Id: Ied80028e2ca03f14a677d31a1ff36b3b8e938a8e
Partial-Bug: 1554139

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-05-20: [Review update] R3.0

#17

Review in progress for https://review.opencontrail.org/20482
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-05-20:

#18

Review in progress for https://review.opencontrail.org/20483
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-05-20:

#19

Review in progress for https://review.opencontrail.org/20484
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-05-23: A change has been merged

#20

Reviewed: https://review.opencontrail.org/20482
Committed: http://github.org/Juniper/contrail-generateDS/commit/9225519c332ac433240ebdcdd79814d72f02d30a
Submitter: Zuul
Branch: R3.0

commit 9225519c332ac433240ebdcdd79814d72f02d30a
Author: Hampapur Ajay <email address hidden>
Date: Mon Mar 7 09:27:59 2016 -0800

Absorb documentation hints for required/operations and any future
ones in idl_parser.

Change-Id: I5734a0c66b6216c5dca40e69b2acab99fdb71f33
Partial-Bug: 1554139
(cherry picked from commit 3d8e2cc5b49eee4fcdaa61e1ab3d96e3b2fd1a4f)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-05-23:

#21

Reviewed: https://review.opencontrail.org/20483
Committed: http://github.org/Juniper/contrail-generateDS/commit/affaa55af2a31e16906e516b6a5f8b579b421e55
Submitter: Zuul
Branch: R3.0

commit affaa55af2a31e16906e516b6a5f8b579b421e55
Author: Hampapur Ajay <email address hidden>
Date: Mon Mar 7 09:27:59 2016 -0800

Add support for documentation related tags in schema definition.

Change-Id: Ib280d8d12abe4892aaee36b58d6d7ef072078445
Partial-Bug: 1554139
(cherry picked from commit 4514eac74c79fb65918425e688566ece2475d7db)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-05-23:

#22

Reviewed: https://review.opencontrail.org/20484
Committed: http://github.org/Juniper/contrail-generateDS/commit/ec3f4e20eb36ff847636a996fd08c07e23db59fc
Submitter: Zuul
Branch: R3.0

commit ec3f4e20eb36ff847636a996fd08c07e23db59fc
Author: Hampapur Ajay <email address hidden>
Date: Thu Mar 31 15:35:04 2016 -0700

Support multi-line description.* tag and generate such ones from
restriction base'd types.

Change-Id: I3e9429fb6a0f5ee126480cc4686f3d970cb15b62
Partial-Bug: 1554139
(cherry picked from commit 5984cdc69b8d03f5c09a7ce7a91d3b1470ae3754)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-07-07: [Review update] master

#23

Review in progress for https://review.opencontrail.org/21733
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-07-07:

#24

Review in progress for https://review.opencontrail.org/21734
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-07-08:

#25

Review in progress for https://review.opencontrail.org/21733
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-07-08: A change has been merged

#26

Reviewed: https://review.opencontrail.org/21734
Committed: http://github.org/Juniper/contrail-controller/commit/defbe0c906f85c9368e7a5766d009edc02f54f98
Submitter: Zuul
Branch: master

commit defbe0c906f85c9368e7a5766d009edc02f54f98
Author: Hampapur Ajay <email address hidden>
Date: Thu Jul 7 14:21:30 2016 -0700

Doc rendering enhancements:
* Sticky sphinx sidebar
* Widen to show all of module path

Change-Id: Icba40e1b8c74bc2cdc5454d0bf94b194450839cf
Partial-Bug: 1554139

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-07-11: [Review update] master

#27

Review in progress for https://review.opencontrail.org/21733
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-07-17: A change has been merged

#28

Reviewed: https://review.opencontrail.org/21733
Committed: http://github.org/Juniper/contrail-controller/commit/a9041973e3ad9ee45710dd3de71552cfd03fdaf1
Submitter: Zuul
Branch: master

commit a9041973e3ad9ee45710dd3de71552cfd03fdaf1
Author: Hampapur Ajay <email address hidden>
Date: Thu Jul 7 14:17:07 2016 -0700

Add documentation for bgp_schema and loadbalancer schema files.

Change-Id: I7837a5858782b5941352ff3ff99e32633eca54b3
Partial-Bug: 1554139

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-07-26: [Review update] master

#29

Review in progress for https://review.opencontrail.org/22450
Submitter: Hampapur Ajay (<email address hidden>)

Ashish Ranjan (aranjan-n) on 2016-08-04

no longer affects:

juniperopenstack/r3.1

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-08-05: A change has been merged

#31

Reviewed: https://review.opencontrail.org/22450
Committed: http://github.org/Juniper/contrail-controller/commit/4d9269154a9f95aa6181bf3aec14b0bbaf48d27d
Submitter: Zuul
Branch: master

commit 4d9269154a9f95aa6181bf3aec14b0bbaf48d27d
Author: Hampapur Ajay <email address hidden>
Date: Tue Jul 26 14:56:53 2016 -0700

Grammar edits suggested by @mkerr in index and headings.

Change-Id: Ie7ad05ab663f1c6dba8ae78b878d61767700aae7
Partial-Bug: 1554139

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-08-09: [Review update] R3.1

#32

Review in progress for https://review.opencontrail.org/23109
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-08-10: A change has been merged

#33

Reviewed: https://review.opencontrail.org/23109
Committed: http://github.org/Juniper/contrail-controller/commit/6957b8190a61ca56be207e3eb5c49abc6e0d77db
Submitter: Zuul
Branch: R3.1

commit 6957b8190a61ca56be207e3eb5c49abc6e0d77db
Author: Hampapur Ajay <email address hidden>
Date: Thu Jul 7 14:17:07 2016 -0700

Add documentation for bgp_schema and loadbalancer schema files.

Change-Id: I7837a5858782b5941352ff3ff99e32633eca54b3
Partial-Bug: 1554139
(cherry picked from commit a9041973e3ad9ee45710dd3de71552cfd03fdaf1)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-08-11: [Review update] master

#34

Review in progress for https://review.opencontrail.org/23200
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-08-12: A change has been merged

#35

Reviewed: https://review.opencontrail.org/23200
Committed: http://github.org/Juniper/contrail-generateDS/commit/deb91b7b4d64e936811195b7c4070db5da54adda
Submitter: Zuul
Branch: master

commit deb91b7b4d64e936811195b7c4070db5da54adda
Author: Hampapur Ajay <email address hidden>
Date: Wed Aug 10 18:48:21 2016 -0700

Generate/Emit class based description if present in schema

Partial-Bug: 1554139
Change-Id: I9789e845c94f76163ed8d6d150738772aeef85c7

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-08-26: [Review update] master

#36

Review in progress for https://review.opencontrail.org/23614
Submitter: Hari Prasad Killi (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-08-29: A change has been merged

#37

Reviewed: https://review.opencontrail.org/23614
Committed: http://github.org/Juniper/contrail-controller/commit/1d15a8d6736cb9504ea159e5cdfc3fd38a9e79e6
Submitter: Zuul
Branch: master

commit 1d15a8d6736cb9504ea159e5cdfc3fd38a9e79e6
Author: Hari <email address hidden>
Date: Fri Aug 26 12:33:05 2016 +0530

Update comment to document features that do not work when policy is disabled.

Change-Id: I0c371dd385edd52fdeb5454b19acc2c95f40a0ee
partial-bug: #1554139

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-11-08: [Review update] master

#38

Review in progress for https://review.opencontrail.org/25840
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-11-09: A change has been merged

#39

Reviewed: https://review.opencontrail.org/25840
Committed: http://github.org/Juniper/contrail-controller/commit/1c2e0dc1df6cfdc63c5fed423d39f751f44fb0e2
Submitter: Zuul
Branch: master

commit 1c2e0dc1df6cfdc63c5fed423d39f751f44fb0e2
Author: Hampapur Ajay <email address hidden>
Date: Tue Nov 8 14:17:29 2016 -0800

Fix typos in schema documentation/description.

Partial-Bug: 1554139
Change-Id: If2c5a0c215504c63cf34ef8f46e0f13dc470e902

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-11-10: [Review update] R3.2

#40

Review in progress for https://review.opencontrail.org/25910
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-11-10: [Review update] R3.1

#41

Review in progress for https://review.opencontrail.org/25911
Submitter: Hampapur Ajay (<email address hidden>)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-11-10: A change has been merged

#42

Reviewed: https://review.opencontrail.org/25911
Committed: http://github.org/Juniper/contrail-controller/commit/cdf4f0e1174cd01391a15c706b6e0d3b62bf2b99
Submitter: Zuul
Branch: R3.1

commit cdf4f0e1174cd01391a15c706b6e0d3b62bf2b99
Author: Hampapur Ajay <email address hidden>
Date: Tue Nov 8 14:17:29 2016 -0800

Fix typos in schema documentation/description.

Partial-Bug: 1554139
Change-Id: If2c5a0c215504c63cf34ef8f46e0f13dc470e902
(cherry picked from commit 1c2e0dc1df6cfdc63c5fed423d39f751f44fb0e2)

Revision history for this message

OpenContrail Admin (ci-admin-f) wrote on 2016-11-10:

#43

Reviewed: https://review.opencontrail.org/25910
Committed: http://github.org/Juniper/contrail-controller/commit/aecc8480fe3ce19e745d786bf894c2bb55519151
Submitter: Zuul
Branch: R3.2

commit aecc8480fe3ce19e745d786bf894c2bb55519151
Author: Hampapur Ajay <email address hidden>
Date: Tue Nov 8 14:17:29 2016 -0800

Fix typos in schema documentation/description.

Partial-Bug: 1554139
Change-Id: If2c5a0c215504c63cf34ef8f46e0f13dc470e902
(cherry picked from commit 1c2e0dc1df6cfdc63c5fed423d39f751f44fb0e2)

Report a bug

This report contains Public information

Everyone can see this information.

You are

Subscribing...

Edit bug mail

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.